v34

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

InboxesWebhooks

Create Webhook

Create a webhook scoped to this inbox.

CLI:

agentmail inboxes:webhooks create --inbox-id <inbox_id> --url https://example.com/webhook --event-type message.received

post/v0/inboxes/{inbox_id}/webhooks

inbox_idstring required

The ID of the inbox.

urlstring required

URL of webhook endpoint.

event_typesEventType[] required

Event types for which to send events.

client_idstring

Client ID of webhook.

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.