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.

Prop	Type	Default
`topics?`	`ActivityTopicDto[]`	-
`to?`	`ActivityNotificationResponseDtoTo`	-
`controls?`	`Controls`	-
`tags?`	`string[]`	-
`payload?`	`ActivityNotificationResponseDtoPayload`	-
`jobs?`	`ActivityNotificationJobResponseDto[]`	-
`template?`	`ActivityNotificationTemplateResponseDto`	-
`subscriber?`	`ActivityNotificationSubscriberResponseDto`	-
`channels?`	`StepTypeEnum[]`	-
`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.

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

Notification event

Workflow

ChannelTypeEnum

On this page