Webhooks

Update webhook

Partially update a webhook.

patch/api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}

Request

  • Base URL: https://api.mail.hostinger.com
  • URL: https://api.mail.hostinger.com/api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}
  • Auth: HTTP bearer

Path parameters

mailboxResourceIdstring required

Resource ID of the managed mailbox.

webhookstring uuid required

Webhook identifier (UUID v7).

Request body

namestring

Human-readable webhook name.

descriptionstring nullable

Free-text note about the webhook purpose. Send null to clear.

eventsstring[]

Event types that trigger a delivery. Replaces the current list.

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

Delivery state. Only active webhooks receive events; paused keeps config but stops deliveries.

urlstring uri

HTTPS endpoint that receives POST deliveries, authenticated with the webhook secret as Authorization: Bearer <secret>. Must be a public domain name (no IPs or internal hosts).

Example request

{
  "name": "Renamed webhook",
  "description": "Updated description",
  "events": [
    "message.received"
  ],
  "status": "paused",
  "url": "https://example.com/webhooks/new"
}

Response

Updated webhook.

Example response

{
  "data": {
    "id": "019683f8-1234-7abc-8def-0123456789ab",
    "accountResourceId": "AC1a2b3c4d5e6f7g",
    "mailbox": "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",
    "createdAt": "2026-04-07T12:00:00+00:00",
    "updatedAt": "2026-04-07T12:00:00+00:00"
  }
}

Changes

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