Fire an Event

Notify multiple users

This API enables you to notify multiple users with one event trigger.

Before firing your first notification event, you must perform the following actions in your Fyno account:

Create a Template
Create an Event
Create an API Key
And obtain your workspace ID from the API Keys page.

post/{WSID}/{version}/event/bulk

Path parameters

WSIDstring required

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

version'live' | 'test' required

Enter the version for which you wish to fire the notification.

Request body

eventstring required

Enter the name of the event you wish to fire.

Example request

{
  "batch": [
    {
      "callback": {
        "custom_id": "ID001",
        "custom1": "EV001",
        "custom2": "P001",
        "custom3": "C001",
        "enable": true
      },
      "data": {
        "placeholder_key_1": "placeholder_value_1",
        "placeholder_key_2": "placeholder_value_2"
      },
      "to": {
        "discord": "101XXXXXXXXXX7XXXXX",
        "email": "abcde@fghi.com",
        "inapp": "12345",
        "push": "ExponentPushToken[XXXXX]",
        "slack": "CXXXXXXXXXX",
        "sms": "+919879XXXXXX",
        "teams": "General",
        "voice": "+919879XXXXXX",
        "whatsapp": "+919879XXXXXX"
      }
    }
  ],
  "event": "event_name"
}

Response

Request accepted successfully and it will be processed asynchronously.

eventstring

received_timenumber

request_idstring

Example response

{
  "event": "event_name",
  "received_time": 1672991866453,
  "request_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "response": [
    {
      "discord": {
        "destination": "101XXXXXXXXXX7XXXXX",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "email": {
        "destination": "abcde@fghi.com",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "inapp": {
        "destination": "12345",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "push": {
        "destination": "ExponentPushToken[XXXXX]",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "seq": 1,
      "slack": {
        "destination": "CXXXXXXXXXX",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "sms": {
        "destination": "+919879XXXXXX",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "teams": {
        "destination": "General",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "voice": {
        "destination": "+919879XXXXXX",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "whatsapp": {
        "destination": "+919879XXXXXX",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      }
    }
  ]
}

Changes

Changed in 8 of the 35 revisions of this API.839

Aug 6, 2026021088e9cb3011See the full diff
- ▲
  removed subschema #1 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added
Feb 17, 2026b3e90463b15a11See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added
Apr 22, 2025bfd089d6624111See the full diff
- ▲
  removed subschema #1 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added
Feb 17, 2025ee2cf82f4e6a132See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added
- ○
  the response property _message became required for the status 400
  response-property-became-required
- ○
  the response property _message became required for the status 401
  response-property-became-required
- ○
  the response property response/items/discord/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/discord/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/discord/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/email/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/email/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/email/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/inapp/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/inapp/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/inapp/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/push/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/push/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/push/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/slack/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/slack/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/slack/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/sms/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/sms/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/sms/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/teams/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/teams/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/teams/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/voice/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/voice/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/voice/status became required for the status 202
  response-property-became-required
- ○
  the response property response/items/whatsapp/destination became required for the status 202
  response-property-became-required
- ○
  the response property response/items/whatsapp/msg_id became required for the status 202
  response-property-became-required
- ○
  the response property response/items/whatsapp/status became required for the status 202
  response-property-became-required
- ○
  the response property status became required for the status 400
  response-property-became-required
- ○
  the response property status became required for the status 401
  response-property-became-required
Feb 12, 20254a67858d11ce11See the full diff
- ▲
  removed subschema #1 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added
This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 10, 20251e381a0ba09d11See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20252dd806ab440c11See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added
Feb 7, 20257b479358bfc011See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the batch/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added subschema #1 subschema #2 subschema #3 to the batch/items/ request property oneOf list
  request-property-one-of-added

Full history