Sign in
latestOpenAPI 3.1.02026-08-19127114508.1 KB

ccbc269bc193

Webhooks

Update webhook

Update webhook.

patch/api/v1/webhooks/{id}

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"
}