Sign in

v33

latestOpenAPI 3.0.2raw.githubusercontent.com2026-03-142353151.8 KB
Fire an Event

Notify multiple users

This API enables you to notify multiple users with one event trigger.<br/><br/>Before firing your first notification event, you must perform the following actions in your Fyno account:<br/>- Create a Template<br/>- Create an Event<br/>- Create an API Key<br/>- 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"
      }
    }
  ]
}