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

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/events/trigger/broadcast
  • Auth: API key in header Authorization

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

Changes

No recorded changes to this operation across all 1 revision of this API.