Notify multiple users | Fyno Documentation

curl -X POST https://api.fyno.io/v1/FYXXXXXXXX/live/event/bulk \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "batch": [
    {
      "to": {}
    }
  ],
  "event": "event_name"
}'

{
  "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"
      }
    }
  ]
}

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.

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.

Authentication

AuthorizationBearer

Enter your API Key. If you don't have it already, you can create one from the API Keys page within your Fyno account

Path parameters

WSIDstringRequired

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

versionenumRequiredDefaults to live

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

Allowed values:

Request

This endpoint expects an object.

batchlist of objectsRequired

Your batch payload must specify at least distinct_id or to while firing a notification event.

If the payload contains:

Option 1: ONLY to (and no distinct_id) - the event uses all destination values from the to object (as it is).
Option 2: ONLY distinct_id (and no to) - the event uses all destination values (such as SMS, WhatsApp, Email, Push, Voice and so on) from the user’s profile and sends the notification.
Option 3: BOTH distinct_id and to - the to and distinct_id channel data merges (to object take precedences) and sends the notification. The sent notification is tagged to the ID specified, which can be then used to search the logs by using distinct_id.

eventstringRequired

Enter the name of the event you wish to fire.

Response

Request accepted successfully and it will be processed asynchronously.

eventstringOptional

received_timedoubleOptional

request_idstringOptional

responselist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error