inboxes > webhooks

Update Webhook Headers

Changed on

Atomically set, replace, or remove custom HTTP headers included with deliveries to this inbox-scoped webhook. Header values remain write-only.

patch/v0/inboxes/{inbox_id}/webhooks/{webhook_id}/headers

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/webhooks/{webhook_id}/headers
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

webhook_idstring required

ID of webhook.

Request body

headersWebhooksWebhookHeaders

Custom HTTP headers to include with every delivery to this webhook. Header values are write-only: AgentMail never returns them from webhook read endpoints. The map must contain at least one entry when provided, and every name and value must be a valid HTTP header.

remove_headersstring[]

Names of custom delivery headers to remove.

Response

Response with status 204

object required

Changes