Sign in

v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB
Mail: Webhooks

Update webhook

Partially update a webhook. Only the fields included in the request body are changed; omitted fields retain their current values. Pass "description": null to clear the description.

patch/api/mail/v1/webhooks/{webhookId}

Path parameters

webhookIdstring required
Example:019683f8-1234-7abc-8def-0123456789ab

Webhook ID (returned when the webhook was created)

Request body

namestring

New human-readable name for the webhook

descriptionstring nullable

New description, or null to clear it

eventsstring[]

Replaces the full list of subscribed events

status'active' | 'disabled' | 'paused'

New status for the webhook

urlstring

New URL to deliver events to

Example request

{
  "name": "Updated notifier",
  "description": "Now also handles newsletters",
  "events": [
    "message.received"
  ],
  "status": "paused",
  "url": "https://example.com/webhooks/incoming"
}

Response

Success response

idstring

Unique webhook identifier

namestring

Human-readable name for this webhook

descriptionstring nullable

Optional description of the webhook's purpose

eventsstring[]

Events that trigger this webhook

status'active' | 'disabled' | 'paused'

Current status of the webhook

urlstring

URL that receives webhook POST requests

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "019683f8-1234-7abc-8def-0123456789ab",
  "mailbox": {
    "id": "AC1a2b3c4d5e6f7g",
    "address": "user@example.com"
  },
  "name": "New message notifier",
  "description": "Notifies our CRM when a new email arrives",
  "events": [
    "message.received"
  ],
  "status": "active",
  "url": "https://example.com/webhooks/incoming",
  "created_at": "2026-07-23T12:00:00Z",
  "updated_at": "2026-07-23T12:00:00Z"
}