Skip to content
API PlatformDevelopers

Webhook events · broadcasts

broadcast.created/1

Broadcast created. A broadcast was created in the app.

Payload

We POST this JSON to your endpoint. Answer any 2xx within 30 seconds. The same id arrives again on a retry — skip ones you have handled.

Payload fields
FieldTypeWhat it is
idrequiredstringEvent id. The same on every retry: use it to skip duplicates.pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$
typerequiredstringEvent type.always broadcast.created
versionrequiredstringPayload version.always 1
api_versionrequiredstringThe endpoint's API version.
occurred_atrequiredstringWhen it happened.date-time
company_idrequiredintegerYour workspace id.
datarequiredobject
idrequiredintegerBroadcast id.
company_idrequiredintegerWorkspace id.
channel_idrequiredintegerChannel id.
namestring or nullName.
statusrequiredstringStatus.
scheduled_atstring or nullISO 8601.
totalsrequiredobject
failedrequiredintegerFailed.
recipientsrequiredintegerRecipients.
sentrequiredintegerSent.

Example

{
  "id": "evt_01J8Z7BZQ4F6G8J2K5N7Q9S1VC",
  "type": "broadcast.created",
  "version": "1",
  "api_version": "2026-10-01",
  "occurred_at": "2026-09-24T09:20:00Z",
  "company_id": 1001,
  "data": {
    "id": 8812,
    "company_id": 1001,
    "channel_id": 301,
    "name": "September sale",
    "status": "SCHEDULED",
    "scheduled_at": "2026-09-15T07:00:00Z",
    "totals": {
      "failed": 0,
      "recipients": 5300,
      "sent": 0
    }
  }
}

Headers

  • Webhook-Signature: t=…,v1=… — how to check it
  • Webhook-Id (also Webhook-Event-Id): the event id, the same on every retry — skip ones you have handled
  • Webhook-Delivery-Id: this delivery attempt, new on every try