v1

latestOpenAPI 3.0.1raw.githubusercontent.com2026-04-2099201202.6 KB

Webhooks

Create Webhook

CLI:

agentmail webhooks create --url https://example.com/webhook --event-type message.received

post/v0/webhooks

urlstring required

URL of webhook endpoint.

event_typesEventType[] required

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.

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.