API ReferenceNotification Event

Notify a single user

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:

Request

Your event 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 notification event uses all destination values from the *`to`* object (as it is). - **Option 2:** ONLY *`distinct_id`* (and no *`to`*) - the notificaton 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`.
objectRequired
OR
objectRequired
OR
objectRequired

Response

Request accepted successfully and it will be processed asynchronously.
eventstring
received_timedate
request_idstring
responseobject

Errors

400
Bad Request Error
401
Unauthorized Error