API ReferenceInboxesWebhooks

Update Webhook Headers

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.
webhook_idstringRequired
ID of webhook.

Request

This endpoint expects an object.
headersmap from strings to stringsOptional

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_headerslist of stringsOptional
Names of custom delivery headers to remove.

Response

This endpoint returns an object.

Errors

400
Validation Error
404
Not Found Error