Get notifications

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

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization

string

header

required

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

Query Parameters

channels

enum<string>[]

Array of channel types

Available options:

in_app,

email,

sms,

chat,

push

templates

string[]

Array of template IDs or a single template ID

emails

string[]

Array of email addresses or a single email address

search

string

deprecated

Search term (deprecated)

subscriberIds

string[]

Array of subscriber IDs or a single subscriber ID

page

number

default:

0

Page number for pagination

transactionId

string

Transaction ID for filtering

after

string

Date filter for records after this timestamp

before

string

Date filter for records before this timestamp

Response

200 - application/json

data

object[]

required

Array of activity notifications

Show child attributes

data._environmentId

string

required

Environment ID of the notification

data._organizationId

string

required

Organization ID of the notification

data._subscriberId

string

required

Subscriber ID of the notification

data.transactionId

string

required

Transaction ID of the notification

data._digestedNotificationId

string

Digested Notification ID

data._id

string

Unique identifier of the notification

data._templateId

string

Template ID of the notification

data.channels

enum<string>[]

Available options:

in_app,

email,

sms,

chat,

push,

digest,

trigger,

delay,

custom

data.controls

object

Controls associated with the notification

data.createdAt

string

Creation time of the notification

data.jobs

object[]

Jobs of the notification

Show child attributes

data.jobs._id

string

required

Unique identifier of the job

data.jobs.executionDetails

object[]

required

Execution details of the job

Show child attributes

data.jobs.executionDetails._id

string

required

Unique identifier of the execution detail

data.jobs.executionDetails.detail

string

required

Detailed information about the execution

data.jobs.executionDetails.isRetry

boolean

required

Whether the execution is a retry or not

data.jobs.executionDetails.isTest

boolean

required

Whether the execution is a test or not

data.jobs.executionDetails.providerId

enum<string>

required

Provider ID of the job

Available options:

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,

clickatell,

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

data.jobs.executionDetails.source

enum<string>

required

Source of the execution detail

Available options:

Credentials,

Internal,

Payload,

Webhook

data.jobs.executionDetails.status

enum<string>

required

Status of the execution detail

Available options:

Success,

Warning,

Failed,

Pending,

Queued,

ReadConfirmation

data.jobs.executionDetails.createdAt

string

Creation time of the execution detail

data.jobs.executionDetails.raw

string | null

Raw data of the execution

data.jobs.providerId

enum<string>

required

Provider ID of the job

Available options:

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,

clickatell,

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

data.jobs.status

string

required

Status of the job

data.jobs.step

object

required

Step details of the job

Show child attributes

data.jobs.step._id

string

required

Unique identifier of the step

data.jobs.step._templateId

string

required

The identifier for the template associated with this step

data.jobs.step.active

boolean

required

Whether the step is active or not

data.jobs.step.filters

object[]

required

Filter criteria for the step

Show child attributes

data.jobs.step.filters.children

object[]

required

Show child attributes

data.jobs.step.filters.isNegated

boolean

required

data.jobs.step.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.jobs.step.filters.value

enum<string>

required

Available options:

AND,

OR

data.jobs.step._parentId

string | null

The unique identifier for the parent step

data.jobs.step.controlVariables

object

Control variables

data.jobs.step.issues

object

Step issues

data.jobs.step.metadata

object

Metadata for the workflow step

data.jobs.step.name

string

The name of the step

data.jobs.step.replyCallback

object

Reply callback settings

data.jobs.step.template

object

Optional template for the step

data.jobs.step.variants

object[]

Variants of the step

Show child attributes

data.jobs.step.variants._id

string

required

Unique identifier of the step

data.jobs.step.variants._templateId

string

required

The identifier for the template associated with this step

data.jobs.step.variants.active

boolean

required

Whether the step is active or not

data.jobs.step.variants.filters

object[]

required

Filter criteria for the step

Show child attributes

data.jobs.step.variants._parentId

string | null

The unique identifier for the parent step

data.jobs.step.variants.controlVariables

object

Control variables

data.jobs.step.variants.issues

object

Step issues

data.jobs.step.variants.metadata

object

Metadata for the workflow step

data.jobs.step.variants.name

string

The name of the step

data.jobs.step.variants.replyCallback

object

Reply callback settings

data.jobs.step.variants.template

object

Optional template for the step

data.jobs.step.variants.variants

object[]

Variants of the step

Show child attributes

data.jobs.type

enum<string>

required

Type of the job

Available options:

in_app,

email,

sms,

chat,

push,

digest,

trigger,

delay,

custom

data.jobs.digest

object

Optional digest for the job, including metadata and events

Show child attributes

data.jobs.digest.type

enum<string>

required

The Digest Type

Available options:

regular,

backoff,

timed

data.jobs.digest.amount

number

Amount for the digest

data.jobs.digest.backoff

boolean

Regular digest: Indicates if backoff is enabled for the regular digest

data.jobs.digest.backoffAmount

number

Regular digest: Amount for backoff

data.jobs.digest.backoffUnit

enum<string>

Regular digest: Unit for backoff

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.jobs.digest.digestKey

string

Optional key for the digest

data.jobs.digest.events

object[]

Optional array of events associated with the digest, represented as key-value pairs

data.jobs.digest.timed

object

Configuration for timed digest

Show child attributes

data.jobs.digest.timed.atTime

string

Time at which the digest is triggered

data.jobs.digest.timed.cronExpression

string

Cron expression for scheduling

data.jobs.digest.timed.monthDays

number[]

Specific days of the month for the digest

data.jobs.digest.timed.monthlyType

enum<string>

Type of monthly schedule

Available options:

each,

on

data.jobs.digest.timed.ordinal

enum<string>

Ordinal position for the digest

Available options:

1,

2,

3,

4,

5,

last

data.jobs.digest.timed.ordinalValue

enum<string>

Value of the ordinal

Available options:

day,

weekday,

weekend,

sunday,

monday,

tuesday,

wednesday,

thursday,

friday,

saturday

data.jobs.digest.timed.weekDays

enum<string>[]

Days of the week for the digest

Available options:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

data.jobs.digest.unit

enum<string>

Unit of the digest

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.jobs.digest.updateMode

boolean

Regular digest: Indicates if the digest should update

data.jobs.payload

object

Optional payload for the job

data.jobs.updatedAt

string

Updated time of the notification

data.payload

object

Payload of the notification

data.subscriber

object

Subscriber of the notification

Show child attributes

data.subscriber._id

string

required

Internal to Novu unique identifier of the subscriber

data.subscriber.subscriberId

string

required

External unique identifier of the subscriber

data.subscriber.email

string

Email address of the subscriber

data.subscriber.firstName

string

First name of the subscriber

data.subscriber.lastName

string

Last name of the subscriber

data.subscriber.phone

string

Phone number of the subscriber

data.tags

string[]

Tags associated with the notification

data.template

object

Template of the notification

Show child attributes

data.template.name

string

required

Name of the template

data.template.triggers

object[]

required

Triggers of the template

Show child attributes

data.template.triggers.identifier

string

required

Identifier of the trigger

data.template.triggers.type

enum<string>

required

Type of the trigger

Available options:

event

data.template.triggers.variables

object[]

required

Variables of the trigger

Show child attributes

data.template.triggers.variables.name

string

required

Name of the variable

data.template.triggers.subscriberVariables

object[]

Subscriber variables of the trigger

Show child attributes

data.template.triggers.subscriberVariables.name

string

required

Name of the variable

data.template._id

string

Unique identifier of the template

data.to

object

To field for subscriber definition

data.updatedAt

string

Last updated time of the notification

hasMore

boolean

required

Indicates if there are more activities in the result set

page

number

required

Current page of the activities

pageSize

number

required

Page size of the activities