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
id
stringRequiredThe notification's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
event_name
stringRequiredThe name of the event that the notification was sent for.
resource_type
stringRequiredThe type of resource that the Notification refers to.
resource_id
stringRequiredThe ID of the resource that the Notification refers to.
customer_id
null | stringRequiredThe ID of the customer that this notification was sent to.
The details of the customer that this notification was sent to.
to
stringRequiredThe 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.
data
Record<string, unknown>RequiredThe data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.
parent_id
stringRequiredThe notification's parent ID
The details of the parent notification.
The details of all resends of the notification.
provider_id
stringRequiredThe ID of the notification provider used to send the notification.
The notification provider used to send the notification.
Was this section helpful?