Skip to main content
Optimization Protection

Notifications

The Notifications API provides you with real-time, asynchronous updates about the status of events. You receive notifications for the events to which you are subscribed on the callback URL or email address provided by you.

Availability

The Notifications API is available in the following regions:

  • United States 
  • Europe
  • United Kingdom
  • Australia
  • Canada

Before you begin

You must contact your relationship manager or contact us to onboard Notifications API.

How notifications work

Perform the following steps to get started with Notifications: 

  1. Request access — Follow the steps in Getting started to set up access to the Notifications API.
  2. Determine the notification event types you need — Read about the Notification types offered by the Notifications API.
  3. Add security preferences — Learn about how Security preferences work and how to enable them.
  4. Subscribe to the notification events — Learn how to Subscribe to notifications.
  5. Retrieve the status of webhook verification — Learn how Webhook verification is performed and how to retrieve its status.
  6. Retrieve notifications anytime you want — Learn how to Retrieve notifications.
  7. Verify notifications using public keys — Learn about Public keys.

Webhook retry logic

The Notifications API has its own built-in retry mechanism if the webhook is not delivered.

  1. Initial Attempt: The first attempt to deliver the webhook.
  2. Simple Queue Service (SQS) Retry: If the initial attempt fails, the system will retry delivery twice using the SQS, with each retry occurring at 15-minute intervals.
  3. Extended Retry: If the SQS retries are unsuccessful, the webhook enters the Dead Letter Queue (DLQ). The system continues to attempt delivery over the next two days for DLQ messages, with retries occurring at 24-hour intervals.

Total Attempts: 1 initial +2 SQS + 2 from DLQ 

Attention

If your system was down during the delivery process and the webhook was not delivered, you can retrieve your webhook by performating a GET /notifications call. Learn more about how to Retrieve notifications.