POST
/
v1
/
events
/
trigger
import { Novu } from '@novu/node';

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

await novu.trigger('<WORKFLOW_TRIGGER_IDENTIFIER>',
  {
    to: {
      subscriberId: '<UNIQUE_SUBSCRIBER_IDENTIFIER>',
      email: '[email protected]',
      firstName: 'John',
      lastName: 'Doe',
    },
    payload: {
      name: "Hello World",
      organization: {
        logo: 'https://happycorp.com/logo.png',
      },
    },
  }
);

{
    "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.trigger('<WORKFLOW_TRIGGER_IDENTIFIER>',
  {
    to: {
      subscriberId: '<UNIQUE_SUBSCRIBER_IDENTIFIER>',
      email: '[email protected]',
      firstName: 'John',
      lastName: 'Doe',
    },
    payload: {
      name: "Hello World",
      organization: {
        logo: 'https://happycorp.com/logo.png',
      },
    },
  }
);

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Response

201
application/json
Created

The response is of type object.