Skip to main content

Webhooks

Webhooks provide a way for notifications to be delivered to an external web server whenever certain events occur.
Webhooks

Paxos Webhooks allow you to register your own endpoints to receive asynchronous events driven by the Paxos Platform. Current webhook use-cases are restricted to Identity Events, with more event types to follow. To get started, you will need to:

  1. Setup a webhook consumer for Paxos webhook events, which is a HTTP POST endpoint that accepts and processes events.
  2. Test the webhook consumer by sending a test event to your endpoint.
  3. Secure the endpoint using either API key or OAuth based authentication.
  4. Contact Support to go through webhook registration, specifying which events you would like to receive and process.

Webhook Retries and Limits​

If your consumer endpoint is failing with re-triable errors, we will attempt to retry calling the consumer endpoint for up to 24 hours with an exponential backoff policy. After 24 hours, no additional attempts to deliver the event will be made. Undelivered events can be discovered and processed using List Events and the Events API.

Consumer endpoint invocations are rate-limited to 10 per second.

About this Preview​

All Previews, including the accompanying documentation, are considered unstable, not for production use, and not subject to the API Breaking Change Policy nor any SLA. Feedback is collected from participant developers on a prearranged basis. Contact Support for details.