Skip to main content
objectBroadcastSend

Fields

id
ID!
isTest
Boolean!

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.

scheduledAt

When the send is due, or when it was due if it has already run.

startedAt

When the send began, as opposed to when it was due. Null until it starts.

completedAt

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.

Arguments
first
Int
after
String
last
Int
before
String