short_idstring required
Short human-friendly identifier for the announcement.
messagestring required
Message body to send, rendered as Slack mrkdwn.
status'pending' | 'sending' | 'sent' | 'partially_failed' | 'failed' required
- pending - Pending
- sending - Sending
- sent - Sent
- partially_failed - Partially failed
- failed - Failed
send_as'bot' | 'user'
- bot - SupportHog
- user - The person who created it
sender_display_namestring required
Slack display name the message was posted under when send_as is 'user'; empty otherwise.
total_channelsinteger required
Number of channels this announcement targets.
sent_countinteger required
Number of channels the message was successfully delivered to.
failed_countinteger required
Number of channels delivery failed for.
sent_atstring date-time nullable required
When delivery finished (all channels resolved). Null while pending/sending.
created_atstring date-time required
When the announcement was created.
channelsstring[] required
Slack channel IDs to send to. Each must be a channel the SupportHog bot is a member of; names are resolved server-side.