Sign in

v4

OpenAPI 3.0.0MIT2026-07-311554531.6 MB
Events

Broadcast event to all

Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc. In the future could be used to trigger events to a subset of subscribers based on defined filters.

post/v1/events/trigger/broadcast

Request body

namestring required

The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.

payloadobject required

The payload object is used to pass additional information that could be used to render the template, or perform routing rules based on it. For In-App channel, payload data are also available in <Inbox />

transactionIdstring

A unique identifier for this transaction, we will generated a UUID if not provided.

contextobject

Example request

{
  "payload": {
    "comment_id": "string",
    "post": {
      "text": "string"
    }
  },
  "overrides": {
    "steps": {
      "email-step": {
        "providers": {
          "sendgrid": {
            "templateId": "1234567890"
          }
        },
        "layoutId": "step-specific-layout"
      }
    },
    "channels": {
      "email": {
        "layoutId": "promotional-layout-2024"
      }
    },
    "providers": {
      "sendgrid": {
        "templateId": "1234567890"
      }
    }
  },
  "actor": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "avatar": "https://example.com/avatar.jpg",
    "locale": "en-US",
    "timezone": "America/New_York"
  }
}

Response

OK

acknowledgedboolean required

Indicates whether the trigger was acknowledged or not

status'error' | 'trigger_not_active' | 'no_workflow_active_steps_defined' | 'no_workflow_steps_defined' | 'processed' | 'no_tenant_found' | 'invalid_recipients' required

Status of the trigger

errorstring[]

In case of an error, this field will contain the error message(s)

transactionIdstring

The returned transaction ID of the trigger

activityFeedLinkstring

Link to the activity feed for this trigger event

jobDataobject