Skip to main content
objectBroadcast

Fields

id
ID!
name
String!

Human-readable name used to identify the broadcast. Internal only — it is never shown to recipients. This is what searchBroadcasts matches on.

notificationTitle
String

The title recipients see in the notification the broadcast arrives as. Unlike name this does leave Plain, and a broadcast cannot be sent until it is set. Null until then.

content
String!

The body of the broadcast, encoded as described by contentFormat.

How content is encoded, as declared when the broadcast was created.

The channel this broadcast is authored for. Fixed at creation — content is written against this channel's rendering rules, so a broadcast cannot be moved to another channel.

Who the broadcast is sent as. The variant matches the broadcast's type. Null until a sender is set.

Who the broadcast is sent to. Resolved to concrete recipients at send time, not when scheduled. Empty until a target is set.

Where the broadcast is in its lifecycle.

scheduledAt

When the broadcast's send is due, or when it started if it is already underway. Null while the broadcast is a draft.

startedAt

When the send actually 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.

isDeleted
Boolean!

Whether the broadcast has been soft-deleted. Soft-deleted broadcasts are excluded from lists and search but remain queryable by ID.

createdAt
createdBy
updatedAt
updatedBy
deletedAt

The timestamp at which the broadcast was soft-deleted, or null if it has not been deleted.

deletedBy

The user or machine user that deleted the broadcast, or null if it has not been deleted.