DELETE
/
v1
/
events
/
trigger
/
{transactionId}
import { Novu } from "@novu/node";

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

await novu.events.cancel("transactionId");

{
  "data": true
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

If false value is returned in response, it means that event has already been completed its execution or cancelled before. Already completed event can not be cancelled. If true value is returned in response, then it means that event execution has been cancelled successfully. Any digest or delay step with pending exection will also be cancelled.
import { Novu } from "@novu/node";

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

await novu.events.cancel("transactionId");

{
  "data": true
}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

transactionId
string
required

Response

200 - application/json
data
boolean
required

Was this page helpful?

Broadcast event to allGet subscribers