Cancel triggered event

Using a previously generated transactionId during the event trigger, will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...

Authorization

Authorization<token>

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

In: header

Path Parameters

transactionIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

responseRequiredboolean

export type Response = boolean;

curl -X DELETE "https://api.novu.co/v1/events/trigger/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

true

Broadcast event to all POST

Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc. In the future could be used to trigger events to a subset of subscribers based on defined filters.

Subscriber schema

Reference the Novu subscriber schema used in API requests and responses. Review fields, data types, and object structure for this resource.

Cancel triggered event

Authorization

Path Parameters

Header Parameters

Response Body

On this page