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

Attention! You're currently using the OT&E environment.

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
Notification ID 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
Notification ID Integer Required The ID of the notification
Fire date Timestamp Required The date the notification was fired
Read date Timestamp Optional The date the notification was read
Acknowledge date Timestamp Optional The date the notification was acknowledged
Acknowledge date 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
Reason String Optional The reason of the notification
Process ID Integer Optional The ID of the process the notification was triggered from
Event type String Required The event type of the notification
Notification type String Required The notification type
Payload Object Optional The payload of the notification
Is Async 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.
Process identifier String Optional The process identifier (i.e. domain name, host name, contact handle)
Process type String Optional The process type (i.e. domain, host, contact)

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