---
title: "Update webhook endpoint"
method: PATCH
path: "/v1/webhooks/{webhook_id}"
tags: ["Webhooks"]
---

# Update webhook endpoint

`PATCH /v1/webhooks/{webhook_id}`

## Request

- Base URL: `https://api.winnr.app`
- URL: `https://api.winnr.app/v1/webhooks/{webhook_id}`
- Auth: HTTP bearer

Update a webhook endpoint's `url`, `events`, `description`, or `status`.
At least one field is required.

Setting `status` to `enabled` on an endpoint that was `auto_disabled`
re-enables it, clears `disabled_reason`, and resets
`consecutive_failures` to 0.

## Path parameters

- `webhook_id` string, required

## Request body

- UpdateWebhookRequest: At least one field is required.
  - `url` string, uri: New destination URL. Must be HTTPS.
  - `events` string[]: New subscription list, or `["*"]` for all events
  - `description` string, nullable
  - `status` 'enabled' | 'disabled': `enabled` re-enables a disabled or auto-disabled endpoint, clears `disabled_reason`, and resets `consecutive_failures` to 0. `auto_disabled` cannot be set manually.

## Response `200`

Updated webhook endpoint

- object
  - `data` Webhook: A webhook endpoint. Winnr POSTs signed event notifications to `url` for every subscribed event type. Maximum 10 endpoints per account.
    - `id` string: Webhook endpoint ID
    - `url` string, uri: Destination URL. Must be HTTPS.
    - `description` string, nullable: Optional human-readable label (max 200 chars)
    - `events` string[]: Subscribed event types, or `["*"]` for all events. `"*"` cannot be combined with specific events. Valid types: `message.relayed`, `email.received`, `email.bounced`, `email.complained`, `domain.created`, `domain.ready`, `domain.dns_failed`, `email_user.created`, `email_user.deleted`. (`test.ping` is always deliverable regardless of subscription.)
    - `status` 'enabled' | 'disabled' | 'auto_disabled': `auto_disabled` is set by Winnr after 25 consecutive failed events. Set `enabled` via PATCH to resume deliveries (this also resets `consecutive_failures`).
    - `disabled_reason` string, nullable: Why the endpoint was auto-disabled (null otherwise)
    - `secret_hint` string: Last few characters of the signing secret, for display
    - `api_version` string: Event payload version delivered to this endpoint
    - `consecutive_failures` integer: Consecutive failed events (resets to 0 on success or re-enable)
    - `last_delivery_at` string, date-time, nullable: When the most recent delivery attempt finished
    - `last_delivery_status` string, nullable: Outcome of the most recent delivery attempt
    - `last_success_at` string, date-time, nullable: When a delivery last succeeded
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `meta` Meta
    - `request_id` string
    - `timestamp` string, date-time

## Other responses

- `400`: Validation error
- `401`: Authentication required or token invalid
- `404`: Resource not found

---

[API](https://skmtc.dev/winnr/apis/winnr-api.md) · [All operations](https://skmtc.dev/winnr/apis/winnr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/winnr/apis/winnr-api/revisions/a4f960beb1eb?raw)