---
title: "Broadcast event to all"
method: POST
path: "/v1/events/trigger/broadcast"
tags: ["Events"]
---

# Broadcast event to all

`POST /v1/events/trigger/broadcast`

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.

## Request body

- TriggerEventToAllRequestDto
  - `name` string, required — The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.
  - `payload` object, required — The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
  - `transactionId` string — A unique identifier for this transaction, we will generated a UUID if not provided.
  - `actor` union — It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system
    - string — Unique identifier of a subscriber in your systems
    - SubscriberPayloadDto — At least one of the following properties required for this API : subscriberId, email, phone, whatsappNumber, apnToken, fcmToken.
      - `subscriberId` string — The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
      - `email` string — required if channels used in workflow contains email
      - `firstName` string
      - `lastName` string
      - `phone` string — required if channels used in workflow contains one of the following (sms, voice or viber) and in the format : +9665XXXXXXXX or 9665XXXXXXXX
      - `whatsappNumber` string — required if channels used in workflow contains whatsapp
      - `apnToken` string — required if channels used in workflow contains push notifications with target subscriber iOS user
      - `fcmToken` string — required if channels used in workflow contains push notifications with target subscriber android user
      - `locale` string
      - `data` object

## Response `200`

- object
  - `data` TriggerEventResponseDto
    - `acknowledged` boolean, required — If trigger was acknowledged or not
    - `status` 'processed' | 'trigger_not_active' | 'subscriber_id_missing' | 'error', required — Status for trigger
    - `error` string[] — In case of an error, this field will contain the error message
    - `transactionId` string — Transaction id for trigger

## Other responses

- `201`

---

[API](https://skmtc.dev/cequens/apis/authentication.md) · [All operations](https://skmtc.dev/cequens/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cequens/authentication/revisions/deadb0661f19/schema)