Need help? Call Live Support at +31 (0) 38 453 07 59

Used to retrieve a single notification

  • GETMethod
  • /v2/customers/customer/notifications/notificationIdURL
Name Type Description Restrictions
customer String The handle of the customer
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
notificationId Integer The ID of the 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.

Successful request

  • 200 OKHTTP Status
  • application/jsonContent-Type

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 Required The date the notification was read
acknowledgeDate Timestamp Required The date the notification was acknowledged
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

Failed requests

Generic errors can be expected.

The handle of the customer
The ID of the notification
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.

GET /v2/customers/customer/notifications/notificationId