Authorization
field like the example shown below:E.g ApiKey 18d2e625f05d80e
Idempotent nature of transactionId
Idempotent nature of transactionId
Idempotent nature of transactionId
The transactionId
within Novu is a unique identifier that is used to ensure the idempotent nature of notification delivery.When you trigger an event to send a notification, you have the option to provide a transactionId
. If you do not provide one, Novu will generate a UUID for you.This identifier is particularly useful for preventing the same notification from being sent multiple times in case the trigger event is inadvertently called more than once.By leveraging the transactionId
, you can make idempotent requests, which means if the same transactionId
is used in another request, Novu's API will recognize it and will not send the same notification again.transactionId
.Body
The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.
The recipients list of people who will receive the notification.
The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
{
"comment_id": "string",
"post": { "text": "string" }
}
This could be used to override provider specific configurations
{ "fcm": { "data": { "key": "value" } } }
A unique identifier for this transaction, we will generated a UUID if not provided.
It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system
Unique identifier of a subscriber in your systems
It is used to specify a tenant context during trigger event. If a new tenant object is provided, we will create a new tenant.
Unique identifier of a tenant in your system
Response
Created