AGagentmail-to
Webhooks

Create Webhook

CLI:

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

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/webhooks
  • Auth
    HTTP bearer

Request body

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.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.