Skip to main contentThis guide will help you set up webhooks to receive real-time notifications from Superleap when specific events occur.
Creating a Webhook Endpoint
To start receiving webhook events, you’ll need to create a webhook endpoint in your application:
- Build an HTTP endpoint (URL) on your server that’s publicly accessible
- Configure the endpoint to process incoming POST requests (only POST requests are supported)
- Implement signature verification to ensure the webhook is authentic (see Webhook Security for details)
- Handle incoming webhook payloads and respond with a 2xx status code to acknowledge receipt
Registering Webhooks in Superleap
To register your webhook with Superleap:
Currently the developer dashboard for creating webhooks is under development.
You can create webhooks by reaching out to your POC at Superleap.
Managing Webhooks
Viewing Webhook History
THIS IS A WORK IN PROGRESS, WHEN COMPLETED -
You can view the history of webhook deliveries including:
- Delivery status (success/failure)
- Request/response details
- Timestamp of each attempt
Handling Webhook Deliveries
Responding to Webhooks
Your webhook endpoint should respond with a 2xx HTTP status code as quickly as possible to acknowledge receipt. Superleap will consider any other status code as a failed delivery and will retry according to our retry policy.
Webhook Retry Policy
Every event that receives a non-2xx response is considered an event delivery failure by Superleap’s system. If there is a delivery failure, we retry the delivery in exponential backoff policy for 24 hours after event creation timestamp.
A webhook is retried at progressive intervals of time on failure, defined in the exponential backoff policy upto 1 day. After the first day, the webhook is retried once every 24 hours. If the webhooks continue to fail for 3 days, the message is disabled.
Best Practices
- Process webhooks asynchronously: Acknowledge receipt quickly and process the webhook data in the background
- Implement idempotency: Ensure your system can handle receiving the same webhook multiple times
- Store raw webhook data: Save the raw payload for debugging and reprocessing if needed
- Implement proper error handling: Log failures and set up alerts for webhook processing errors
- Monitor webhook deliveries: Regularly check your webhook logs to ensure events are being properly delivered and processed