Notify a single user | Fyno Documentation

This API enables you to fire a notification event, which sends out notifications to your users.

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

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

This API enables you to fire a notification event, which sends out notifications to your users. Before firing your first notification event, you must perform the following actions in your Fyno account: - Create a Template - Create a Notification 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:

Headers

Idempotency-KeystringOptional

A unique key that makes this request idempotent, for example a UUID such as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. If Fyno receives another request with the same key, it returns the stored response from the first request without firing the notification again, including the original status code and any error. Use this to safely retry a request after a network failure without sending duplicate notifications. The key is scoped to this endpoint.

A unique key that makes this request idempotent, for example a UUID such as `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`. If Fyno receives another request with the same key, it returns the stored response from the first request without firing the notification again, including the original status code and any error. Use this to safely retry a request after a network failure without sending duplicate notifications. The key is scoped to this endpoint.

Request

Your event payload must specify at least distinct_id or to while firing a notification event. Choose one of the three options below.

Option 1: to only

Required: event, to

The notification event uses all destination values from the to object, as they are.

{
  "event": "event_name",
  "to": {
    "email": "abcde@fghi.com",
    "sms": "+49XXXXXXXXX"
  },
  "data": {
    "placeholder_key_1": "placeholder_value_1"
  }
}

Option 2: distinct_id only

Required: event, distinct_id

The notification event uses all destination values (such as SMS, WhatsApp, Email, Push, and Voice) from the user’s profile and sends the notification.

{
  "event": "event_name",
  "distinct_id": "XXXXXXXX",
  "data": {
    "placeholder_key_1": "placeholder_value_1"
  }
}

Option 3: both distinct_id and to

Required: event, distinct_id, to

The to and distinct_id channel data merges, with the to object taking precedence, and the notification is sent. The sent notification is tagged to the ID specified, which you can then use to search the logs by distinct_id.

{
  "event": "event_name",
  "distinct_id": "XXXXXXXX",
  "to": {
    "email": "abcde@fghi.com"
  },
  "data": {
    "placeholder_key_1": "placeholder_value_1"
  }
}

data and callback are optional in all three options.

Your event payload must specify at least `distinct_id` or `to` while firing a notification event. Choose one of the three options below. **Option 1: `to` only** Required: `event`, `to` The notification event uses all destination values from the `to` object, as they are. ```json { "event": "event_name", "to": { "email": "abcde@fghi.com", "sms": "+49XXXXXXXXX" }, "data": { "placeholder_key_1": "placeholder_value_1" } } ``` **Option 2: `distinct_id` only** Required: `event`, `distinct_id` The notification event uses all destination values (such as SMS, WhatsApp, Email, Push, and Voice) from the user's profile and sends the notification. ```json { "event": "event_name", "distinct_id": "XXXXXXXX", "data": { "placeholder_key_1": "placeholder_value_1" } } ``` **Option 3: both `distinct_id` and `to`** Required: `event`, `distinct_id`, `to` The `to` and `distinct_id` channel data merges, with the `to` object taking precedence, and the notification is sent. The sent notification is tagged to the ID specified, which you can then use to search the logs by `distinct_id`. ```json { "event": "event_name", "distinct_id": "XXXXXXXX", "to": { "email": "abcde@fghi.com" }, "data": { "placeholder_key_1": "placeholder_value_1" } } ``` `data` and `callback` are optional in all three options.

Option 1: to onlyobjectRequired

Option 2: distinct_id onlyobjectRequired

Option 3: distinct_id and toobjectRequired

Response

Request accepted successfully and it will be processed asynchronously.

eventstring

received_timedate

request_idstring

responseobject

Errors

400

Bad Request Error

401

Unauthorized Error