PATCH /api/v1/webhooks/{id}

Webhooks

Changed on Oct 20, 2026

Updates an endpoint, event selection, or delivery settings.

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

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Request body

urlstring uri

eventTypesEventType[]

Array of event types to subscribe to.

isActiveboolean

Example request

{
  "url": "https://example.com/webhook",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true
}

Response

Webhook updated

idstring required

urlstring uri required

eventTypesEventType[] required

Array of event types to subscribe to.

isActiveboolean required

consecutiveFailuresinteger 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.

failureHardCapinteger required

Maximum reported failures before needs_attention. It does not pause delivery.

createdAtstring date-time required

Example response

{
  "id": "42",
  "url": "https://example.com/webhooks/xquik",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true,
  "deliveryStatus": "active",
  "failureHardCap": 200,
  "createdAt": "2025-01-15T12:00:00Z"
}

Changes

Oct 20, 202645942c75fdc2 Revision changes
- warning
  added the new topup_in_progress enum value to the ///// response property for the response status
- warning
  added the new topup_in_progress enum value to the ////// response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the / response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status
- warning
  added the new topup_in_progress enum value to the // response property for the response status

Operation history