Webhooks Setup
Configure webhooks to receive real-time notifications when verification events occur.
Why Use Webhooks?
Webhooks are the recommended way to receive verification results. They provide:
Real-time Updates
Receive notifications instantly when verifications complete.
Reliable Delivery
Automatic retries ensure you never miss an event.
Secure Verification
Server-side validation prevents tampering.
Creating a Webhook Endpoint
First, create an endpoint on your server to receive webhook events:
Registering Your Webhook
Via Dashboard
Navigate to Settings
Go to your Dashboard Settings page.
Open Webhooks Section
Click on the "Webhooks" tab in the settings menu.
Add Endpoint
Click "Add Endpoint" and enter your webhook URL.
Select Events
Choose which events you want to receive.
Copy Signing Secret
Save the signing secret securely—you'll need it to verify signatures.
Via API
Response:
secret in a secure environment variable. It's only shown once when creating the webhook.Local Development
For local development, use a tunneling service to expose your local server:
Then register this URL in your dashboard or via the API. Remember to update it when your tunnel URL changes.
Testing Webhooks
Test your webhook endpoint from the dashboard or via API:
You can also view webhook delivery logs in your dashboard under Settings → Webhooks → select your endpoint → View Logs.
Best Practices
Return 2xx quickly
Process webhooks asynchronously and return a 2xx response within 5 seconds to avoid timeouts.
Handle duplicates
Use the event
idto detect and handle duplicate deliveries.Verify signatures
Always verify webhook signatures to ensure events are authentic.
Use HTTPS
Only use HTTPS endpoints in production for secure delivery.