Webhooks

Update a webhook

Any combination of url, name, is_active may be updated. URL changes must remain HTTPS.

put/api/v1/webhooks/{id}

Request

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

Path parameters

idstring uuid required

Request body

urlstring uri

Must start with https:// if supplied.

namestring
is_activeboolean

Response

Updated webhook

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.