webhooks

Edit a webhook

Changes the event types, inbox scope or enabled state. The URL can't be edited: add a webhook with the new URL, then delete this one.

Values are absolute, so a lost or uncertain change is safe to repeat with the same values.

patch/v1/webhooks/{webhook_id}

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/webhooks/{webhook_id}
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

Cherami resource ID returned by the API.

Request body

event_typesWebhookEventType[]
inbox_idsstring[]

Replaces the scope with up to 10 of the account's live inboxes; [] means every inbox, including ones created later. Omit it to keep the current scope.

enabledboolean

false pauses deliveries; true resumes them, including after repeated delivery failures disabled the webhook.

Response

Success.

idstring required

Cherami resource ID.

created_atstring date-time required

UTC timestamp with milliseconds.

urlstring nullable required

Destination URL; null while status is pending or unknown.

event_typesWebhookEventType[] nullable required
inbox_idsstring[] nullable required

Scoped inboxes; empty means every inbox.

deleted_inbox_idsstring[] required

Scoped inboxes that have since been deleted. They match nothing; edit inbox_ids to remove them.

enabledboolean nullable required
updated_atstring date-time nullable required

UTC timestamp with milliseconds.

status'active' | 'disabled' | 'pending' | 'unknown' required
secret_rotated_atstring date-time nullable required

UTC timestamp with milliseconds.

previous_secret_expires_atstring date-time nullable required

UTC timestamp with milliseconds.

Changes

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