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

created_atDateRequired

The date with timezone at which the resource was created.

customerCustomerRequired

The details of the customer that this notification was sent to.

customer_idnull | stringRequired

The ID of the customer that this notification was sent to.

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.

event_namestringRequired

The name of the event that the notification was sent for.

idstringRequired

The notification's ID

parent_idstringRequired

The notification's parent ID

parent_notificationNotificationRequired

The details of the parent notification.

providerNotificationProviderRequired

The notification provider used to send the notification.

provider_idstringRequired

The ID of the notification provider used to send the notification.

resendsNotification[]Required

The details of all resends of the notification.

resource_idstringRequired

The ID of the resource that the Notification refers to.

resource_typestringRequired

The type of resource that the Notification refers 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.

updated_atDateRequired

The date with timezone at which the resource was updated.