Skip to main content
Skip to main content

Notification

A notification is an alert sent, typically to customers, using the installed Notification Provider as a reaction to internal events such as order.placed. Notifications can be resent.

Properties

idstringRequired
The notification's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
event_namestringRequired
The name of the event that the notification was sent for.
resource_typestringRequired
The type of resource that the Notification refers to.
resource_idstringRequired
The ID of the resource that the Notification refers to.
customer_idnull | stringRequired
The ID of the customer that this notification was sent to.
customerCustomerRequired
The details of the customer that this notification was sent to.
tostringRequired
The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.
dataRecord<string, unknown>Required
The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.
parent_idstringRequired
The notification's parent ID
parent_notificationNotificationRequired
The details of the parent notification.
resendsNotification[]Required
The details of all resends of the notification.
provider_idstringRequired
The ID of the notification provider used to send the notification.
providerNotificationProviderRequired
The notification provider used to send the notification.
Was this section helpful?