Trigger event

Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below. To prevent duplicate triggers, you can optionally pass a transactionId in the request body. If the same transactionId is used again, the trigger will be ignored. The retention period depends on your billing tier.

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

In: header

Request Body

application/jsonRequired

nameRequiredstring

The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.

payloadobject

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.

overridesobject

This could be used to override provider specific configurations

The recipients list of people who will receive the notification.

transactionIdstring

A unique identifier for deduplication. If the same transactionId is sent again, the trigger is ignored. Useful to prevent duplicate notifications. The retention period depends on your billing tier.

actorstring | object

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

tenantstring | object

It is used to specify a tenant context during trigger event. Existing tenants will be updated with the provided details.

contextobject

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

Created

acknowledgedRequiredboolean

Indicates whether the trigger was acknowledged or not

statusRequiredstring

Status of the trigger

Value in:

"error" | "trigger_not_active" | "no_workflow_active_steps_defined" | "no_workflow_steps_defined" | "processed" | "no_tenant_found" | "invalid_recipients"

errorarray<string>

In case of an error, this field will contain the error message(s)

transactionIdstring

The returned transaction ID of the trigger

export interface Response {
  /**
   * Indicates whether the trigger was acknowledged or not
   */
  acknowledged: boolean;
  /**
   * Status of the trigger
   */
  status:
    | "error"
    | "trigger_not_active"
    | "no_workflow_active_steps_defined"
    | "no_workflow_steps_defined"
    | "processed"
    | "no_tenant_found"
    | "invalid_recipients";
  /**
   * In case of an error, this field will contain the error message(s)
   */
  error?: string[];
  /**
   * The returned transaction ID of the trigger
   */
  transactionId?: string;
}

curl -X POST "https://api.novu.co/v1/events/trigger" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "workflow_identifier",
    "payload": {
      "comment_id": "string",
      "post": {
        "text": "string"
      }
    },
    "overrides": {
      "fcm": {
        "data": {
          "key": "value"
        }
      }
    },
    "to": [
      {
        "subscriberId": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "avatar": "string",
        "locale": "string",
        "data": {
          "property1": "string",
          "property2": "string"
        },
        "channels": [
          {
            "providerId": "slack",
            "integrationIdentifier": "string",
            "credentials": {
              "webhookUrl": "string",
              "deviceTokens": [
                "string"
              ]
            }
          }
        ],
        "timezone": "string"
      }
    ],
    "transactionId": "string",
    "actor": "string",
    "tenant": "string",
    "context": {
      "property1": "org-acme",
      "property2": "org-acme"
    }
  }'

{
  "acknowledged": true,
  "status": "error",
  "error": [
    "string"
  ],
  "transactionId": "string"
}

Authorization

Request Body

Header Parameters

Response Body

On this page