v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB

Webhooks

Update Webhook

Update inbox or pod subscriptions, or replace the webhook's event_types in full when you pass a non-empty event_types array (see request field docs). Inbox and pod changes use add/remove lists.

CLI:

agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>

patch/v0/webhooks/{webhook_id}

Path parameters

webhook_idstring required

ID of webhook.

Request body

event_typesEventType[]

Event types for which to send events.

Response

webhook_idstring required

ID of webhook.

urlstring required

URL of webhook endpoint.

event_typesEventType[]

Event types for which to send events.

pod_idsstring[]

Pods for which to send events. Maximum 10 per webhook.

inbox_idsstring[]

Inboxes for which to send events. Maximum 10 per webhook.

secretstring required

Secret for webhook signature verification.

enabledboolean required

Webhook is enabled.

updated_atstring date-time required

Time at which webhook was last updated.

created_atstring date-time required

Time at which webhook was created.

client_idstring

Client ID of webhook.