Notification event schema

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.

string

Unique identifier of the notification

environmentId

string

Environment ID of the notification

organizationId

string

Organization ID of the notification

subscriberId

string

Subscriber ID of the notification

transactionId

string

Transaction ID of the notification

templateId

string

Template ID of the notification

digestedNotificationId

string

Digested Notification ID

createdAt

string

Creation time of the notification

updatedAt

string

Last updated time of the notification

channels

string[]

subscriber

ActivityNotificationSubscriberResponseDto

Subscriber of the notification

template

ActivityNotificationTemplateResponseDto

Template of the notification

jobs

ActivityNotificationJobResponseDto[]

Jobs of the notification

payload

{ [k: string]: any; }

Payload of the notification

Workflow

Workflow contains the details of the workflow that was triggered.

string

name

string

description

string

active

boolean

draft

boolean

preferenceSettings

SubscriberPreferenceChannels

critical

boolean

ChannelTypeEnum

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

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