Setup

Register provider webhooks (deprecated)

Deprecated

POST
/api/v1/webhooks/register

Deprecated — use POST /api/v1/setup/provider-webhook. Identical behaviour; the path moved because /api/v1/webhooks now belongs to your OWN endpoints (see the Webhooks tag) and sharing a prefix made two unrelated things look related. This alias keeps working until the sunset date and announces itself on every response.

Authorization

bearerAuth admin
headerAuthorizationBearer <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.

Scope: admin

Response Body

Webhook registered.

application/json
  1. response
endpoint?string
webhook_id?string
Example Request
curl -X POST 'https://sendandretain.com/api/v1/webhooks/register'
Example Response
{  "endpoint": "string",  "webhook_id": "string"}