BroadcastSend
One run of a broadcast: the recipients it resolved to and what became of each of them. A broadcast’s
status, scheduledAt, startedAt and completedAt come from its most recent send, which is why
they read as null or DRAFT on a broadcast that has none.
BroadcastSendFields
Whether this was a test send. A test send posts real messages to real channels and collects real
deliveries, so it is only distinguishable by this field — but it never contributes to the
broadcast's own status.
When the send is due, or when it was due if it has already run.
When the send began, as opposed to when it was due. Null until it starts.
When the send reached a terminal state, whatever that state was. Null until it finishes.
Progress across the send's recipients. Prefer this over counting deliveries — it is one query
regardless of how many recipients the send has.
The send's recipients, one edge per recipient, newest first. Empty until the send has resolved who
it applies to. Requires the broadcast:read permission.
Was this page helpful?

