Skip to main content
POST
/
v1
/
events
/
trigger
/
bulk
import { Novu } from '@novu/node';

const novu = new Novu("<NOVU_API_KEY>");

await novu.events.bulkTrigger([
  {
    name: "<WORKFLOW_TRIGGER_IDENTIFIER>",
    to: "<UNIQUE_SUBSCRIBER_IDENTIFIER>",
    payload: {
      customKey: "customValue",
      customKey1: {
        nestedkey1: "nestedValue1"
      }
    },
    overrides: {
      email: {
        from: "[email protected]"
      }
    },
    // actorId is subscriberId of actor
    actor: "actorId"
    tenant: "tenantIdentifier"
  },
  {
    name: "<WORKFLOW_TRIGGER_IDENTIFIER>",
    to: "<UNIQUE_SUBSCRIBER_IDENTIFIER>",
    payload: {
      customKey: "customValue",
      customKey1: {
        nestedkey1: "nestedValue1"
      }
    },
    overrides: {
      email: {
        from: "[email protected]"
      }
    },
    // actorId is subscriberId of actor
    actor: "actorId"
    tenant: "tenantIdentifier"
  }
])

{
    "data": [
        {
            "acknowledged": true,
            "status": "processed",
            "transactionId": "string"
        }
    ]
}
Enter your API key in the Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80e
import { Novu } from '@novu/node';

const novu = new Novu("<NOVU_API_KEY>");

await novu.events.bulkTrigger([
  {
    name: "<WORKFLOW_TRIGGER_IDENTIFIER>",
    to: "<UNIQUE_SUBSCRIBER_IDENTIFIER>",
    payload: {
      customKey: "customValue",
      customKey1: {
        nestedkey1: "nestedValue1"
      }
    },
    overrides: {
      email: {
        from: "[email protected]"
      }
    },
    // actorId is subscriberId of actor
    actor: "actorId"
    tenant: "tenantIdentifier"
  },
  {
    name: "<WORKFLOW_TRIGGER_IDENTIFIER>",
    to: "<UNIQUE_SUBSCRIBER_IDENTIFIER>",
    payload: {
      customKey: "customValue",
      customKey1: {
        nestedkey1: "nestedValue1"
      }
    },
    overrides: {
      email: {
        from: "[email protected]"
      }
    },
    // actorId is subscriberId of actor
    actor: "actorId"
    tenant: "tenantIdentifier"
  }
])

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
events
object[]
required

Response

Created

​
acknowledged
boolean
required

If trigger was acknowledged or not

​
status
enum<string>
required

Status for trigger

Available options:
error,
trigger_not_active,
no_workflow_active_steps_defined,
no_workflow_steps_defined,
processed,
subscriber_id_missing,
no_tenant_found
​
error
string[]

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

​
transactionId
string

Transaction id for trigger