Send a notification to a user

post

https://{tenant}.haiilo.app/api/plugins/{pluginId}/instance/{srcId}/notification

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pluginId

string

required

The ID of the plug-in (not the plugin instance)

srcId

string

required

The unique ID of the plugin instance

Body Params

recipientEmail

string

the email address of the notification recipient (required if recipientId is not set, but one of them can be set)

recipientId

string

the internal user ID of the notification recipient (required if recipientEmail is not set, but only one of them can be set)

message

string

the notification message independent of user language (required if messages is not set, but only one of them can be set)

messages

object

map of language (lowercase, e.g. "en") to message (required if message is not set)

excerpt

string

the excerpt of the notification (optional but mutually exclusive with excerpts)

excerpts

object

map of language (lowercase, e.g. "en") to excerpt (optional but mutually exclusive with excerpt)

category

string

enum

Defaults to ACTIVITY

the category of the notification (optional).

Allowed:

deeplink

string

length ≤ 255

the deeplink data of the notification which is forwarded to the plugin instance when reading the notification (optional).

Responses

201

Created (notification will be sent asynchronously)

400

The provided data is invalid (includes non-existing references to users, plugins or plugin instances)

404

The notification feature is not available

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here!