webhooks

Set or remove custom headers

Sets and removes custom headers sent with every delivery, in one request; headers you don't name stay as they are. Values are sent as written and never shown again. Use a header for a shared token your receiver checks alongside the signature, or for routing. Repeating the same change is safe.

patch/v1/webhooks/{webhook_id}/headers

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/webhooks/{webhook_id}/headers
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

Cherami resource ID returned by the API.

Request body

setobject

Header name to value. Names are HTTP tokens, stored in lowercase; reserved names (svix-, webhook-, host, content-type, content-length, user-agent) are refused.

removestring[]

Response

Success.

idstring required

Cherami resource ID.

header_namesstring[] required

Changes

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