Getting a Notification

When You Get a Notification

If an event occurs, you will receive a notification that an event with the category and type of your subscription has occurred. The notice will include a URL that includes more details.

You may get the details of the notification in one of two ways.

1. Use the url.href and url.action method provided in the notification.

2. Make a direct call to the associated API (such as Notifications API or Consent API)

Example Notifications

Maintenance

If you've subscribed to the category MAINTENANCE with type PLANNED_OUTAGE and an event occurs, you'll receive a notification similar to this example:

Consent

If you've subscribed to the category CONSENT with type CONSENT_UPDATED and an event occurs, you'll receive a notification similar to this example:

If you've subscribed to the category CONSENT with type CONSENT_REVOKED and an event occurs, you'll receive a notification similar to this example:

url.href and url.action

To use this method, use the url.href provided in the notificationPayload with your service token. You'll receive a JSON object as a response (example in the next paragraph).

Direct Call to Associated API

You may also make a call to the associated API to get the notification details.

For details related to a MAINTENANCE event, use the GET Maintenance Notification Details endpoint with the id received in the notificationPayload:

MAINTENANCE Example Response

for details related to a CONSENT event, use the GET Consent Grant endpoint (link) with the id received in the notificationPayload.

CONSENT Event Example Response:

Notification Errors