> ## Documentation Index
> Fetch the complete documentation index at: https://novu-c5de82d9-docs-homepage-redesign.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Notification event schema

> 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.

<ResponseField name="id" type="string">
  Unique identifier of the notification
</ResponseField>

<ResponseField name="environmentId" type="string">
  Environment ID of the notification
</ResponseField>

<ResponseField name="organizationId" type="string">
  Organization ID of the notification
</ResponseField>

<ResponseField name="subscriberId" type="string">
  Subscriber ID of the notification
</ResponseField>

<ResponseField name="transactionId" type="string">
  Transaction ID of the notification
</ResponseField>

<ResponseField name="templateId" type="string">
  Template ID of the notification
</ResponseField>

<ResponseField name="digestedNotificationId" type="string">
  Digested Notification ID
</ResponseField>

<ResponseField name="createdAt" type="string">
  Creation time of the notification
</ResponseField>

<ResponseField name="updatedAt" type="string">
  Last updated time of the notification
</ResponseField>

<ResponseField name="channels" type="string[]" />

<ResponseField name="subscriber" type="ActivityNotificationSubscriberResponseDto">
  Subscriber of the notification
</ResponseField>

<ResponseField name="template" type="ActivityNotificationTemplateResponseDto">
  Template of the notification
</ResponseField>

<ResponseField name="jobs" type="ActivityNotificationJobResponseDto[]">
  Jobs of the notification
</ResponseField>

<ResponseField name="payload" type="{ [k: string]: any; }">
  Payload of the notification
</ResponseField>

<ResponseField name="tags" type="string[]">
  Tags associated with the notification
</ResponseField>

<ResponseField name="controls" type="{ [k: string]: any; }">
  Controls associated with the notification
</ResponseField>

<ResponseField name="to" type="{ [k: string]: any; }">
  To field for subscriber definition
</ResponseField>

<ResponseField name="topics" type="ActivityTopicDto[]">
  Topics of the notification
</ResponseField>

<ResponseField name="severity" type="SeverityLevelEnum">
  Severity of the workflow
</ResponseField>

<ResponseField name="critical" type="boolean">
  Criticality of the notification
</ResponseField>

<ResponseField name="contextKeys" type="string[]">
  Context (single or multi) in which the notification was sent
</ResponseField>

### Workflow

Workflow contains the details of the workflow that was triggered.

<ResponseField name="id" type="string" />

<ResponseField name="name" type="string" />

<ResponseField name="description" type="string" />

<ResponseField name="active" type="boolean" />

<ResponseField name="draft" type="boolean" />

<ResponseField name="preferenceSettings" type="SubscriberPreferenceChannels" />

<ResponseField name="critical" type="boolean" />

<ResponseField name="tags" type="string[]" />

<ResponseField name="steps" type="NotificationStepDto[]" />

<ResponseField name="organizationId" type="string" />

<ResponseField name="creatorId" type="string" />

<ResponseField name="environmentId" type="string" />

<ResponseField name="triggers" type="NotificationTrigger[]" />

<ResponseField name="notificationGroupId" type="string" />

<ResponseField name="parentId" type="string" />

<ResponseField name="deleted" type="boolean" />

<ResponseField name="deletedAt" type="string" />

<ResponseField name="deletedBy" type="string" />

<ResponseField name="notificationGroup" type="NotificationGroup" />

<ResponseField name="data" type="WorkflowResponseData" />

<ResponseField name="workflowIntegrationStatus" type="WorkflowIntegrationStatus" />

### ChannelTypeEnum

ChannelTypeEnum is the type of the channel that the notification was sent to.

```typescript theme={null}
ChannelTypeEnum {
  IN_APP = "in_app",
  EMAIL = "email",
  SMS = "sms",
  CHAT = "chat",
  PUSH = "push"
}
```
