Novu

Novu integration (Communication, Developer Tools). Imported from open-connector.

API key5 tools{api_base_url}

GET

novu_search_subscribers

Search Novu subscribers with filters and cursor pagination.

/v2/subscribers

10 parameters

Param	Type	Required	Description
after	string	optional	Cursor after which to fetch results.
before	string	optional	Cursor before which to fetch results.
limit	integer	optional	Maximum number of subscribers to return.
orderDirection	string	optional	Sort direction.
orderBy	string	optional	Field to order subscribers by.
includeCursor	boolean	optional	Whether to include the cursor item in the response.
email	string	optional	Email address to filter subscribers by.
name	string	optional	Name to filter subscribers by.
phone	string	optional	Phone number to filter subscribers by.
subscriberId	string	optional	Subscriber identifier to filter subscribers by.

POST

novu_create_subscriber

Create or upsert a Novu subscriber.

/v2/subscribers

11 parameters

Param	Type	Required	Description
subscriberId	string	required	Unique subscriber identifier from your system.
firstName	string	optional	The subscriber's first name.
lastName	string	optional	The subscriber's last name.
email	string	optional	The subscriber's email address.
phone	string	optional	The subscriber's phone number.
avatar	string	optional	The subscriber avatar URL or identifier.
locale	string	optional	The subscriber locale, such as en-US.
timezone	string	optional	The subscriber timezone, such as America/New_York.
data	object	optional	Custom data stored with the Novu resource.
failIfExists	boolean	optional	Whether Novu should fail if the subscriber already exists.
idempotencyKey	string	optional	Optional idempotency key sent with the request.

GET

novu_get_subscriber

Retrieve a Novu subscriber by subscriber ID.

/v2/subscribers/{subscriberId}

1 parameter

Param	Type	Required	Description
subscriberId	string	required	The subscriber identifier from your system.

PATCH

novu_update_subscriber

Update a Novu subscriber by subscriber ID.

/v2/subscribers/{subscriberId}

10 parameters

Param	Type	Required	Description
subscriberId	string	required	The subscriber identifier from your system.
firstName	string	optional	The subscriber's first name.
lastName	string	optional	The subscriber's last name.
email	string	optional	The subscriber's email address.
phone	string	optional	The subscriber's phone number.
avatar	string	optional	The subscriber avatar URL or identifier.
locale	string	optional	The subscriber locale, such as en-US.
timezone	string	optional	The subscriber timezone, such as America/New_York.
data	object	optional	Custom data stored with the Novu resource.
idempotencyKey	string	optional	Optional idempotency key sent with the request.

POST

novu_trigger_event

Trigger a Novu workflow event for subscribers or topics.

/v1/events/trigger

9 parameters

Param	Type	Required	Description
name	string	required	The workflow trigger identifier.
to	string	required	One or more trigger recipients.
payload	object	optional	Custom data stored with the Novu resource.
overrides	object	optional	Provider, channel, or step overrides for the trigger.
transactionId	string	optional	Unique deduplication identifier for this trigger.
actor	string	optional	Actor subscriber ID or actor object.
tenant	string	optional	A tenant ID or rich tenant object.
context	object	optional	Context objects keyed by context name.
idempotencyKey	string	optional	Optional idempotency key sent with the request.