NOnovu
Events

Broadcast event to all

Changed on

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

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

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

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

Changes

  • a5b639d63138Revision changes
    • breaking

      the ///// request property format changed from no format to email

  • f056922796adRevision changes
    • info

      added the new google-chat enum value to the request property ///////

    • info

      added the new photon-imessage enum value to the request property ///////