Used to retrieve a single notification
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
fields | String | Optional | Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included. |
|
Below are listed the generic notification response fields. There may be additional response fields, depending on the type of notification.
Name | Type | Required / Optional | Description |
---|---|---|---|
id | Integer | Required | The ID of the notification |
fireDate | Timestamp | Required | The date the notification was fired |
readDate | Timestamp | Optional | The date the notification was read |
acknowledgeDate | Timestamp | Optional | The date the notification was acknowledged |
deliveryDate | Timestamp | Optional | The date the notification was delivered (via webhook) |
message | String | Required | The message of the notification |
reason | String | Optional | The reason of the notification |
customer | String | Optional | The reason of the notification |
process | Integer | Optional | The ID of the process the notification was triggered from |
eventType | String | Required | The event type of the notification |
notificationType | String | Required | The notification type |
payload | Object | Optional | The payload of the notification |
isAsync | Boolean | Required | Flag indicating if the notification relates to an asynchronous event. An asynchronous event is any event which was not immediately completed or an event triggered by the system. |
Generic errors can be expected.
GET /v2/customers/customer/notifications/notificationId