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": [
    "string"
  ],
  "status": "enabled",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "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 body3 fields

Field	Type	Description
`url`required	string	—
`events`required	string[]	—
`name`	string	—

Response · 201 fields9 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`url`required	string	—
`events`required	string[]	—
`status`required	enumenabled \| disabled \| suspended	—
`created_at`required	string	—
`updated_at`required	string	—
`signing_secret`required	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

Create a webhook endpoint

Create a webhook endpoint

Search docs and guides