API ReferenceInboxesWebhooks

Update Webhook

**CLI:** ```bash agentmail inboxes:webhooks update --inbox-id <inbox_id> --webhook-id <webhook_id> --event-type message.received ```

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.
event_typeslist of enumsOptional

When you send a non-empty list, it replaces the webhook’s subscribed event types in full (the same “set the list” behavior as create). It is not a merge or diff: include every event type you want after the update. Sending a one-element array means the webhook will only receive that one type afterward. Omit this field or send an empty array to leave event types unchanged. Clearing all types with an empty list is not supported. Subscribing to message.received.spam, message.received.blocked, or message.received.unauthenticated requires the matching label permission on the API key.

Response

This endpoint returns an object.
webhook_idstring
ID of webhook.
urlstring
URL of webhook endpoint.
secretstring
Secret for webhook signature verification.
enabledboolean
Webhook is enabled.
updated_atdatetime
Time at which webhook was last updated.
created_atdatetime
Time at which webhook was created.
event_typeslist of enums
Event types for which to send events.
pod_idslist of strings
Pods for which to send events. Maximum 10 per webhook.
inbox_idslist of strings
Inboxes for which to send events. Maximum 10 per webhook.
client_idstring
Client ID of webhook.

Errors

400
Validation Error
404
Not Found Error