Webhooks

Update webhook

Partial update. Any of url, events, description, inbox_ids, is_active and endpoint_secret may be supplied; unknown fields are ignored and at least one known field is required. inbox_ids: [] clears the inbox scope. Setting is_active to true also resets the consecutive-failure counter, so an auto-disabled endpoint starts over with a full disable budget.

patch/v1/webhooks/{webhook_id}

Request

  • Base URL: https://api.deadsimple.email
  • URL: https://api.deadsimple.email/v1/webhooks/{webhook_id}
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

Request body

urlstring uri
eventsstring[]
descriptionstring
inbox_idsstring[]
is_activeboolean
endpoint_secretstring

The receiving service's own Standard Webhooks secret (whsec_...), for endpoints that verify every request against it, such as Grok Automations. Each delivery then also carries webhook-id (the delivery id, stable across retries), webhook-timestamp and webhook-signature (v1,<base64 HMAC-SHA256 of "id.timestamp.body">) per standardwebhooks.com. Such receivers answer an unsigned request with HTTP 400. Write-only. A whsec_ value supplied as Authorization: Bearer whsec_... in headers is treated the same way and not sent as a header. null removes it.

Response

Updated webhook

webhook_idstring uuid
workspace_idstring uuid
urlstring uri
eventsstring[]
is_activeboolean
headersobject

Custom delivery headers, values masked (write-only).

endpoint_secret_setboolean

True when deliveries are also signed with the receiver's own Standard Webhooks secret (see endpoint_secret on create). The secret itself is write-only and never returned.

inbox_idsstring[]

Inboxes this webhook is restricted to. Empty means every inbox.

created_atstring date-time

Changes

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