Notification event schema Model API Reference (Notifications)
Reference the Novu notification event schema used in API requests and responses. Review fields, data types, and object structure for this resource.
Notification event
Notification event is the event that is generated when a workflow is triggered to subscribers. It contains workflow details, subscriber details payload sent during trigger, execution details of each step in the workflow and the result of the execution of each step.
| Prop | Type | Default |
|---|---|---|
contextKeys? | string[] | - |
critical? | boolean | - |
severity? | SeverityLevelEnum | - |
topics? | ActivityTopicDto[] | - |
to? | { [k: string]: any; } | - |
controls? | { [k: string]: any; } | - |
tags? | string[] | - |
payload? | { [k: string]: any; } | - |
jobs? | ActivityNotificationJobResponseDto[] | - |
template? | ActivityNotificationTemplateResponseDto | - |
subscriber? | ActivityNotificationSubscriberResponseDto | - |
channels? | string[] | - |
updatedAt? | string | - |
createdAt? | string | - |
digestedNotificationId? | string | - |
templateId? | string | - |
transactionId? | string | - |
subscriberId? | string | - |
organizationId? | string | - |
environmentId? | string | - |
id? | string | - |
Workflow
Workflow contains the details of the workflow that was triggered.
| Prop | Type | Default |
|---|---|---|
workflowIntegrationStatus? | WorkflowIntegrationStatus | - |
data? | WorkflowResponseData | - |
notificationGroup? | NotificationGroup | - |
deletedBy? | string | - |
deletedAt? | string | - |
deleted? | boolean | - |
parentId? | string | - |
notificationGroupId? | string | - |
triggers? | NotificationTrigger[] | - |
environmentId? | string | - |
creatorId? | string | - |
organizationId? | string | - |
steps? | NotificationStepDto[] | - |
tags? | string[] | - |
critical? | boolean | - |
preferenceSettings? | SubscriberPreferenceChannels | - |
draft? | boolean | - |
active? | boolean | - |
description? | string | - |
name? | string | - |
id? | string | - |
ChannelTypeEnum
ChannelTypeEnum is the type of the channel that the notification was sent to.
Retrieve a topic subscription GET
Retrieve a subscription by its unique identifier for a topic.
List all events GET
List all notification events (triggered events) for the current environment. This API supports filtering by **channels**, **templates**, **emails**, **subscriberIds**, **transactionId**, **topicKey**, **severity**, **contextKeys**. Checkout all available filters in the query section. This API returns event triggers, to list each channel notifications, check messages APIs.