Notifications

The notification object and the allowed CRUD operations on the related resource endpoint

Notification can be attached to some resources and fetched (also by sales channels) by including them as an association when retrieving the resource they belong to (which is referenced in the notifiable attribute).

Notifications can be created manually via API (you need to use integration API credentials). In some cases, they are automatically generated by some specific integrations with external services. The notification message and/or any other related information is stored within the body JSON object.

Notifications can be marked as flash. Flash notifications are temporary and will be deleted each time a new notification of the same type is created.

The flash feature is enabled only for notifications automatically generated based on the specific integration setup. Setting the attribute to true for notifications manually created via API currently has no effect.

At the moment, notifications are available for orders and line items (in the future, the feature will be extended to other resources).

Last updated