Create a webhook endpoint
POST/api/v1/webhooks
POST /webhooks
curl -X POST 'https://www.unitpost.com/api/v1/webhooks' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'User-Agent: my-app/1.0' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://example.com/webhooks/unitpost",
"events": [
"email.delivered",
"email.bounced"
]
}'Response · 201
{
"object": "webhook",
"id": "id_123",
"name": "Example",
"url": "https://example.com",
"events": [
"email.sent"
],
"status": "enabled",
"include_text": false,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"backlog": {
"queued": 0,
"failed": 0
},
"signing_secret": "string"
}Register an https URL to receive event notifications (deliveries, bounces, opens, clicks, and more) and choose which events it subscribes to. The response includes the signing_secret exactly once — store it now, as it can never be retrieved again; use it to verify each delivery's signature. Confirm the endpoint works with Send a test event, and adjust its URL or events later with Update a webhook endpoint. Requires the webhooks:manage capability.
Request body4 fields
| Field | Type | Description |
|---|---|---|
urlrequired | string | — |
eventsrequired | enum | string[] | — |
name | string | — |
include_text | boolean | `email.received` deliveries to this endpoint also carry the message's plain-text body as `text`, at most 64 KB (`text_truncated` says it was cut). Null for a copy of one of your own sends (`sent_by_us`), a message deleted since, or one with no plain-text part. Default false: metadata only. The text is read when each delivery is sent and is never kept with the event, so the deliveries log doesn't show it. |
Response · 201 fields11 fields
| Field | Type | Description |
|---|---|---|
objectrequired | string | — |
idrequired | string | — |
namerequired | string | — |
urlrequired | string | — |
eventsrequired | enum | string[] | — |
statusrequired | enumenabled | disabled | suspended | — |
include_text | boolean | `email.received` deliveries to this endpoint also carry the message's plain-text body as `text`, at most 64 KB (`text_truncated` says it was cut). Null for a copy of one of your own sends (`sent_by_us`), a message deleted since, or one with no plain-text part. Default false: metadata only. The text is read when each delivery is sent and is never kept with the event, so the deliveries log doesn't show it. |
created_atrequired | string | — |
updated_atrequired | string | — |
backlog | object | The deliveries a flush would send. Each count stops at 10,001, which means more than 10,000. Only on `GET /webhooks/{id}`. |
signing_secretrequired | string | The HMAC signing secret. Shown exactly once — store it now; it can never be retrieved again. Use it to verify the signature on every delivery to this endpoint. |
201401403409422