FYfynoio
Fire an Event

Notify multiple users

Changed on

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

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/{version}/event/bulk
  • Auth
    HTTP bearer

Path parameters

WSIDstring required

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

versionstring 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": "+419XXXXXX",
        "teams": "General",
        "voice": "+19XXXXXXXX",
        "whatsapp": "+419879XXXXXX"
      }
    }
  ],
  "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": "+49XXXXXXXXX",
        "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": "+49XXXXXXXXX",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      },
      "whatsapp": {
        "destination": "+49XXXXXXXXX",
        "msg_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:XXXX",
        "status": "ok"
      }
    }
  ]
}

Changes

  • 8da6660e185eRevision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 from the / request property oneOf list

    • info

      added subschema #1: Option 1: to only subschema #2: Option 2: distinct_id only subschema #3: Option 3: distinct_id and to to the / request property oneOf list

  • f620f85db863Revision changes
    • breaking

      removed the enum value live from the path request parameter version

    • breaking

      removed the enum value test from the path request parameter version

    • breaking

      removed subschema #1 subschema #3 from the / request property oneOf list

    • info

      added subschema #1 subschema #3 to the / request property oneOf list