Python SDK
Utilities
Configure Webhooks
Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
POST
Python SDK
Overview
Configure webhook endpoints to receive real-time notifications about job status changes. This endpoint returns a portal link where you can manage your webhook configurations.Webhook event delivery is currently under development. The configuration portal is fully functional, but events are not yet being sent.
Get Portal Link
How It Works
Portal Features
The webhook configuration portal allows you to:- Add Multiple Endpoints - Configure different URLs for different event types
- Set Authentication - Add headers or basic auth to your webhooks
- Filter Events - Choose which events to receive at each endpoint
- Test Endpoints - Send test events to verify your setup
- View Logs - See delivery attempts and debug failed webhooks
Webhook Security
Each webhook request includes security headers for verification:Verifying Webhook Signatures
Webhook Events (Coming Soon)
Once enabled, you’ll receive events for:Job Status Events
Event Types
| Event | Description |
|---|---|
job.created | New async job created |
job.processing | Job started processing |
job.completed | Job completed successfully |
job.failed | Job failed with error |
job.cancelled | Job was cancelled |
Example Implementation
Webhook Handler
Complete Integration Example
Best Practices
Endpoint Security
Endpoint Security
- Use HTTPS endpoints only
- Implement signature verification
- Add IP allowlisting if possible
- Use authentication headers
Error Handling
Error Handling
- Return 2xx status for successful receipt
- Implement idempotency to handle retries
- Log all received events
- Handle timeouts gracefully
Performance
Performance
- Process webhooks asynchronously
- Respond quickly (< 5 seconds)
- Queue events for processing
- Implement proper concurrency controls
Troubleshooting
Common Issues
| Issue | Solution |
|---|---|
| Not receiving webhooks | Check endpoint URL is publicly accessible |
| Signature verification fails | Ensure you’re using the correct secret |
| Timeouts | Process webhooks async and respond quickly |
| Duplicate events | Implement idempotency using webhook-id |
Testing Your Endpoint
Before going live:- Use webhook testing tools like ngrok for local development
- Send test events from the portal
- Verify signature validation works
- Test error handling and retries
- Monitor initial production events closely
Next Steps
API Reference
Explore other endpoints
Async Processing
Learn about async jobs
