Webhooks

List webhook endpoints

GET
/api/v1/webhooks

Every endpoint configured for this project. Secrets are never included.

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/webhooks"
{  "data": [    {      "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"    }  ]}