Example notification object
{
"object": "notification_payload",
"id": 12345,
"created_at": 1570906800,
"dispatched": false,
"status": "built",
"error": null,
"type": "email"
}
A notification_payload contains the information about the channels through which the notification has been triggered and the status for said channels.
| FIELD | DESCRIPTION |
|---|---|
| id integer | Unique identifier of the notification |
| dispatched boolean | Whether or not the notification_payload has been dispatched |
| status string | One of 'built', 'dispatched', 'error' or 'cancel' |
| error string | In case an error has occurred for this notification_payload, details about the error. |
| type string | Corresponds to the channel through which the notification_payload has been sent (sms, email, etc.) |
| created_at datetime | Time at which the notification was created |