| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
String | ✔️ | Unique identifier for the notification. | 615c1f2f9b0c5b001f8e4e3b |
templateId |
String | ✔️ | Identifier for the template used to generate the notification. | template_12345 |
environmentId |
String | ✔️ | Identifier for the environment where the notification is sent. | env_67890 |
messageTemplateId |
Optional<String> | ➖ | Identifier for the message template used. | message_template_54321 |
organizationId |
String | ✔️ | Identifier for the organization sending the notification. | org_98765 |
notificationId |
String | ✔️ | Unique identifier for the notification instance. | notification_123456 |
subscriberId |
String | ✔️ | Unique identifier for the subscriber receiving the notification. | subscriber_112233 |
feedId |
JsonNullable<String> | ➖ | Identifier for the feed associated with the notification. | feed_445566 |
jobId |
String | ✔️ | Identifier for the job that triggered the notification. | job_778899 |
createdAt |
OffsetDateTime | ➖ | Timestamp indicating when the notification was created. | 2024-12-10T10:10:59.639Z |
updatedAt |
OffsetDateTime | ➖ | Timestamp indicating when the notification was last updated. | 2024-12-10T10:10:59.639Z |
actor |
Optional<ActorFeedItemDto> | ➖ | Actor details related to the notification, if applicable. | |
subscriber |
Optional<SubscriberFeedResponseDto> | ➖ | Subscriber details associated with this notification. | |
transactionId |
String | ✔️ | Unique identifier for the transaction associated with the notification. | transaction_123456 |
templateIdentifier |
JsonNullable<String> | ➖ | Identifier for the template used, if applicable. | template_abcdef |
providerId |
JsonNullable<String> | ➖ | Identifier for the provider that sends the notification. | provider_xyz |
content |
String | ✔️ | The main content of the notification. | This is a test notification content. |
subject |
JsonNullable<String> | ➖ | The subject line for email notifications, if applicable. | Test Notification Subject |
channel |
ChannelTypeEnum | ✔️ | Channel type through which the message is sent | |
read |
boolean | ✔️ | Indicates whether the notification has been read by the subscriber. | false |
seen |
boolean | ✔️ | Indicates whether the notification has been seen by the subscriber. | true |
archived |
boolean | ✔️ | Indicates whether the notification has been archived by the subscriber. | false |
deviceTokens |
List<String> | ➖ | Device tokens for push notifications, if applicable. | [ "token1", "token2" ] |
cta |
MessageCTA | ✔️ | Call-to-action information associated with the notification. | |
status |
NotificationFeedItemDtoStatus | ✔️ | Current status of the notification. | sent |
payload |
Map<String, Object> | ➖ | The payload that was used to send the notification trigger. | { "key": "value" } |
data |
Map<String, Object> | ➖ | The data sent with the notification. | { "key": "value" } |
overrides |
Map<String, Object> | ➖ | Provider-specific overrides used when triggering the notification. | { "overrideKey": "overrideValue" } |
tags |
List<String> | ➖ | Tags associated with the workflow that triggered the notification. | [ "tag1", "tag2" ] |