Skip to main content

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

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. Subscribe to the notification events — Learn how to Subscribe to notifications.
  4. Add security preferences — Learn about how Security preferences work and how to enable them.
  5. Retrieve notifications anytime you want — Learn how to Retrieve notifications.
  6. Verify notifications using public keys — Learn about Public keys.

Notification types

Notification responses

Testing notifications

Subscribe to notification

Retrieve notifications

Public keys

Security preferences