Webhooks

Create a webhook endpoint

POST
/api/v1/webhooks

Registers an HTTPS endpoint to receive email events, and returns its signing secret.

The secret is shown exactly once. There is no endpoint that returns it again — if you lose it, rotate. Verify every delivery against the RAW request body with any Standard Webhooks library (standardwebhooks on npm/PyPI/Go), or see the receive-webhooks guide.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from the dashboard under Settings → API keys, sent as Authorization: Bearer aem_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see messages, contacts and metrics. Changes nothing, and cannot send.
  • write — everything read does, plus managing templates, contacts, automations, segments and suppressions. This is what editing a template needs.
  • admin — everything write does, plus sending configuration: domains, senders, webhook registration, kill switch, daily cap, brand.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Delivering mail to a real inbox needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

Give your application the lowest tier that works. Most need write and the grant — the dashboard mints that combination as Send + manage; Manage only is the same rung with the grant withheld.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "https://hooks.acme.com/sendandretain",    "event_types": [      "email.delivered",      "email.bounced",      "webhook.test"    ]  }'
{  "id": "whe_9f2a1c",  "url": "https://hooks.acme.com/sendandretain",  "description": "CRM sync",  "event_types": [    "email.delivered",    "email.bounced"  ],  "enabled": true,  "disabled_at": "2019-08-24T14:15:22Z",  "disabled_reason": "string",  "secret_hint": "whsec_…4f9a",  "consecutive_failures": 0,  "last_delivery_at": "2019-08-24T14:15:22Z",  "last_success_at": "2019-08-24T14:15:22Z",  "last_error": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "secret": "whsec_MfKQ9r8sTn3xW1yZ4bC7dE0fG2hJ5kL8"}