---
title: "PATCH /api/v1/webhooks/{id}"
method: PATCH
path: "/api/v1/webhooks/{id}"
tags: ["Webhooks"]
---

# PATCH /api/v1/webhooks/{id}

`PATCH /api/v1/webhooks/{id}`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/webhooks/{id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Updates an endpoint, event selection, or delivery settings.

## Path parameters

- `id` string, required

## Request body

- object
  - `url` string, uri
  - `eventTypes` EventType[]: Array of event types to subscribe to.
  - `isActive` boolean

## Response `200`

Webhook updated

- Webhook: Webhook endpoint registered to receive event deliveries.
  - `id` string, required
  - `url` string, uri, required
  - `eventTypes` EventType[], required: Array of event types to subscribe to.
  - `isActive` boolean, required
  - `consecutiveFailures` integer, required: Consecutive failed delivery attempts since the last success.
  - `deliveryStatus` 'active' | 'paused' | 'needs_attention', required: Endpoint delivery state. paused means the user paused delivery. needs_attention marks repeated failures. Delivery attempts continue.
  - `failureHardCap` integer, required: Maximum reported failures before needs_attention. It does not pause delivery.
  - `createdAt` string, date-time, required

## Other responses

- `400`: Invalid input. A value past its maxLength gets this answer, & the message names the field & its limit.
- `401`: Unauthenticated
- `404`: Not found
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 12 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `400`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - …8 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/webhooks/:id/patch.md)

---

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