Webhooks

Get a webhook endpoint

GET
/api/v1/webhooks/{id}

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

Path Parameters

id*string

Endpoint id.

Response Body

Endpoint.

application/json
  1. response
id?string
url?string
description?string|null
event_types?array<string>
enabled?boolean
disabled_at?|
Formatdate-time
disabled_reason?|

consecutive_failures (auto-disabled after sustained failure), manual (you disabled it, or the endpoint returned 410 Gone), or url_unsafe (the URL stopped resolving to a public address).

secret_hint?string

Last four characters of the signing secret, so you can tell which one is configured. The full secret is returned ONLY when the endpoint is created or its secret is rotated.

consecutive_failures?integer
last_delivery_at?|
Formatdate-time
last_success_at?|
Formatdate-time
last_error?string|null
created_at?string
Formatdate-time
updated_at?string
Formatdate-time
Example Request
curl -X GET 'https://sendandretain.com/api/v1/webhooks/string'
Example Response
{  "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"}