Update Webhook
CLI:
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Request
Inbox IDs to subscribe to the webhook. This only adds to what the webhook receives: on a webhook
that covers its whole pod, it changes nothing. To receive only specific inboxes, create a webhook
with inbox_ids instead. The webhook can list at most 10 inboxes and pods combined after the
update.
Set to true to re-enable a webhook that was disabled after repeated failed deliveries, or false
to disable it. AgentMail does not notify you when a webhook is disabled automatically; check this
field when you get or list webhooks. Events that occurred while the webhook was disabled are not
redelivered. Re-enabling requires the read permission for every restricted event type the webhook
subscribes to: label_spam_read, label_blocked_read, or label_unauthenticated_read for the
received variants, message_read for message.security.*, and calendar_event_read for
calendar.event.*. A webhook with no event type filter is checked against all of them.
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 to leave event types unchanged. An empty array is rejected with a 400: a webhook
always has at least one event type. Subscribing to message.received.spam, message.received.blocked, or
message.received.unauthenticated requires the matching label permission on the API key.
Response
Whether the webhook is enabled. It becomes false when you disable it, and also when deliveries to
the URL have failed for 5 days, in which case AgentMail sends no notification. Re-enable it with
update and enabled set to true.
ID of the pod the webhook belongs to: the pod it was created in, or the pod of the inbox it
belongs to. Absent for an organization webhook and on some inbox webhooks. This is not the
list of pods it receives events for; see pod_ids.
ID of the inbox the webhook belongs to, if it was created for an inbox. This is not the list
of inboxes it receives events for; see inbox_ids.