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

Headers

idempotency-keystring

A header for idempotency purposes

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 />

agentIdstring nullable

Override the workflow-assigned agent for this trigger using the public agent identifier. Omit to use the workflow default; pass null to disable agent routing for this execution.

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"
      }
    }
  },
  "agentId": "support-agent",
  "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

acknowledgedboolean required

Indicates whether the trigger was acknowledged or not

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

Changes

Changed in 5 of the 12 revisions of this API.27

Aug 30, 202624e82408dec711See the full diff
- ▲
  removed the enum value novu-agent-chat of the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-removed
- ○
  added the new novu-web-chat enum value to the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 16, 2026c2b2fa0d5d4811See the full diff
- ▲
  removed the enum value novu-web-chat of the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-removed
- ○
  added the new novu-agent-chat enum value to the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-added
Aug 4, 2026ca78ba2357031See the full diff
- ○
  added the new optional request property agentId
  new-optional-request-property
Jul 31, 20268092e41edd571See the full diff
- ○
  added the new novu-web-chat enum value to the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 21, 2026c69777f601843See the full diff
- ○
  added the new line enum value to the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-added
- ○
  added the new sendblue enum value to the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-added
- ○
  added the new webex-messaging enum value to the request property actor/oneOf[SubscriberPayloadDto]/channels/items/providerId
  request-property-enum-value-added

Full history