API Reference
Notifications
Integrations
Subscribers
- GETGet subscribers
- POSTBulk create subscribers
- PUTUpdate subscriber credentials
- PATCHModify subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber messages as seen, read, unseen or unread
- POSTMarks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
- GETSearch for subscribers
- POSTCreate subscriber
- GETGet subscriber
- DELDelete subscriber
- PATCHPatch subscriber
- GETGet subscriber preferences
- PATCHUpdate subscriber global or workflow specific preferences
Get notification
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Headers
A header for idempotency purposes
Path Parameters
Response
Environment ID of the notification
Organization ID of the notification
Subscriber ID of the notification
Transaction ID of the notification
Digested Notification ID
Unique identifier of the notification
Template ID of the notification
in_app, email, sms, chat, push, digest, trigger, delay, custom Controls associated with the notification
Creation time of the notification
Jobs of the notification
Unique identifier of the job
Execution details of the job
Unique identifier of the execution detail
Detailed information about the execution
Whether the execution is a retry or not
Whether the execution is a test or not
Provider ID of the job
emailjs, mailgun, mailjet, mandrill, nodemailer, postmark, sendgrid, sendinblue, ses, netcore, infobip-email, resend, plunk, mailersend, mailtrap, clickatell, outlook365, novu-email, sparkpost, email-webhook, braze, nexmo, plivo, sms77, sms-central, sns, telnyx, twilio, gupshup, firetext, infobip-sms, burst-sms, bulk-sms, isend-sms, forty-six-elks, kannel, maqsam, termii, africas-talking, novu-sms, sendchamp, generic-sms, clicksend, bandwidth, messagebird, simpletexting, azure-sms, ring-central, brevo-sms, eazy-sms, mobishastra, fcm, apns, expo, one-signal, pushpad, push-webhook, pusher-beams, novu, slack, discord, msteams, mattermost, ryver, zulip, grafana-on-call, getstream, rocket-chat, whatsapp-business Source of the execution detail
Credentials, Internal, Payload, Webhook Status of the execution detail
Success, Warning, Failed, Pending, Queued, ReadConfirmation Creation time of the execution detail
Raw data of the execution
Provider ID of the job
emailjs, mailgun, mailjet, mandrill, nodemailer, postmark, sendgrid, sendinblue, ses, netcore, infobip-email, resend, plunk, mailersend, mailtrap, clickatell, outlook365, novu-email, sparkpost, email-webhook, braze, nexmo, plivo, sms77, sms-central, sns, telnyx, twilio, gupshup, firetext, infobip-sms, burst-sms, bulk-sms, isend-sms, forty-six-elks, kannel, maqsam, termii, africas-talking, novu-sms, sendchamp, generic-sms, clicksend, bandwidth, messagebird, simpletexting, azure-sms, ring-central, brevo-sms, eazy-sms, mobishastra, fcm, apns, expo, one-signal, pushpad, push-webhook, pusher-beams, novu, slack, discord, msteams, mattermost, ryver, zulip, grafana-on-call, getstream, rocket-chat, whatsapp-business Status of the job
Step details of the job
Unique identifier of the step
The identifier for the template associated with this step
Whether the step is active or not
Filter criteria for the step
subscriber, payload LARGER, SMALLER, LARGER_EQUAL, SMALLER_EQUAL, EQUAL, NOT_EQUAL, ALL_IN, ANY_IN, NOT_IN, BETWEEN, NOT_BETWEEN, LIKE, NOT_LIKE, IN BOOLEAN, TEXT, DATE, NUMBER, STATEMENT, LIST, MULTI_LIST, GROUP AND, OR The unique identifier for the parent step
Control variables
Step issues
Metadata for the workflow step
The name of the step
Reply callback settings
Optional template for the step
Variants of the step
Unique identifier of the step
The identifier for the template associated with this step
Whether the step is active or not
Filter criteria for the step
BOOLEAN, TEXT, DATE, NUMBER, STATEMENT, LIST, MULTI_LIST, GROUP AND, OR The unique identifier for the parent step
Control variables
Step issues
Metadata for the workflow step
The name of the step
Reply callback settings
Optional template for the step
Variants of the step
Unique identifier of the step
The identifier for the template associated with this step
Whether the step is active or not
Filter criteria for the step
The unique identifier for the parent step
Control variables
Step issues
Metadata for the workflow step
The name of the step
Reply callback settings
Optional template for the step
Variants of the step
Type of the job
in_app, email, sms, chat, push, digest, trigger, delay, custom Optional digest for the job, including metadata and events
The Digest Type
regular, backoff, timed Amount for the digest
Regular digest: Indicates if backoff is enabled for the regular digest
Regular digest: Amount for backoff
Regular digest: Unit for backoff
seconds, minutes, hours, days, weeks, months Optional key for the digest
Optional array of events associated with the digest, represented as key-value pairs
Configuration for timed digest
Time at which the digest is triggered
Cron expression for scheduling
Specific days of the month for the digest
Type of monthly schedule
each, on Ordinal position for the digest
1, 2, 3, 4, 5, last Value of the ordinal
day, weekday, weekend, sunday, monday, tuesday, wednesday, thursday, friday, saturday Days of the week for the digest
monday, tuesday, wednesday, thursday, friday, saturday, sunday Unit of the digest
seconds, minutes, hours, days, weeks, months Regular digest: Indicates if the digest should update
Optional payload for the job
Updated time of the notification
Payload of the notification
Subscriber of the notification
Internal to Novu unique identifier of the subscriber
External unique identifier of the subscriber
Email address of the subscriber
First name of the subscriber
Last name of the subscriber
Phone number of the subscriber
Tags associated with the notification
Template of the notification
Name of the template
Triggers of the template
Identifier of the trigger
Type of the trigger
event Variables of the trigger
Name of the variable
Unique identifier of the template
To field for subscriber definition
Last updated time of the notification
Was this page helpful?