The notification object

A comprehensive list of the notification resource's attributes and relationships

A notification object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/notifications endpoint.

Fields

Field	Type	Description
type	string	notifications
id	string	The notification unique identifier
links.self	string	The notification endpoint URL
attributes.name	string	The internal name of the notification.
attributes.flash	boolean	Indicates if the notification is temporary, valid for the ones created by external services.
attributes.body	object	An internal body of the notification.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.notifiable	object	The resource the notification belongs to.
meta.mode	string	The resource environment (can be one of test or live)