Skip to main content
inputCreateBroadcastInput

Fields

name
String!
required
notificationTitle
String

The title recipients see in the notification. Can be set later, but is required before the broadcast can be sent.

content
String!
required

The body of the broadcast, encoded as declared by contentFormat. Callers outside the Plain app should send SLACK_BLOCK_KIT and a JSON array of Slack blocks; see BroadcastContentFormat for what is accepted.

contentFormat

How content is encoded.

type
required
isLinkUnfurlingEnabled
Boolean

Whether Slack expands the links and media in this broadcast. Defaults to true, which is Slack's own behaviour. Only meaningful for a SLACK broadcast.

Which kind of sender senderUserId describes. Required alongside senderUserId, and rejected with it when PLAIN.

senderUserId
ID
senderEmailAddress
String