Learn how to use Webhook APIs V6.
Overview
The Webhook API allows you to configure and manage webhooks for various email events. Webhooks notify external systems in real-time when specified events occur, by sending POST requests to configured URLs.
Authentication
All requests require an API key passed in the Authorization header:
Authorization: Bearer <api_key>
Available Endpoints
| Endpoint Name | Method | Endpoint | Description |
|---|---|---|---|
| Create Webhook | POST | /v6/webhooks | Creates a new webhook configuration. |
| List Webhooks | GET | /v6/webhooks | Retrieves all configured webhooks. |
| Get Webhook | GET | /v6/webhooks/{id} | Fetches details of a specific webhook. |
| Update Webhook | PUT | /v6/webhooks/{id} | Replaces an existing webhook configuration. |
| Partial Update Webhook | PATCH | /v6/webhooks/{id} | Updates specific fields in a webhook configuration. |
| Delete Webhook | DELETE | /v6/webhooks/{id} | Deletes a webhook permanently. |
Event Types
| Event Type | Description |
|---|---|
delivered | Email successfully delivered |
bounce | Email bounced |
open | Email opened |
click | Link clicked in email |
unsubscribe | Recipient unsubscribed |
spam | Marked as spam |
dropped | Email dropped |
invalid | Invalid email |
scheduled | Email scheduled |
cancelled | Email cancelled |
Common Error Codes
| Status Code | Description |
|---|---|
400 | Bad Request – Invalid parameters or validation |
401 | Unauthorized – Invalid or missing API key |
403 | Forbidden – Insufficient permissions |
500 | Internal Server Error |
Limitations
- A maximum of 2 webhooks are allowed per client.
- Webhook URLs must be valid and publicly accessible.
- Only allowed event types are accepted.
Notes
- Webhooks deliver POST requests to configured URLs when events occur.
- Custom headers are optional but must be provided in valid JSON format if used.
- Webhook configurations are scoped per client account.