Webhooks

Create a webhook endpoint

URL must be HTTPS. Returns 422 Unprocessable Entity if the organization has reached the maximum number of active webhooks.

post/api/v1/webhooks

Request

  • Base URL: https://api.dmarc-examiner.com
  • URL: https://api.dmarc-examiner.com/api/v1/webhooks
  • Auth: API key in header X-API-Key

Request body

urlstring uri required

Must start with https://.

namestring required

Response

Webhook created

idstring uuid required
urlstring uri required

HTTPS URL events are delivered to.

namestring required
secretstring required

Shared secret used to sign deliveries (HMAC-SHA256). Verify the X-Signature header on each incoming POST.

is_activeboolean required
last_triggered_atstring date-time nullable
last_statusinteger nullable

HTTP status code of the most recent delivery attempt.

failure_countinteger required

Consecutive failure count. Resets on a successful delivery.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "url": "https://example.com/dmarc-events",
  "name": "Production"
}

Changes

No recorded changes to this operation across all 1 revision of this API.