Update a webhook subscription

PATCH /api/v1/webhook_subscriptions/{id}

webhooks:write

Partial update of url, event_filter and active; omitted keys keep their value. PUT /webhook_subscriptions/{id} is accepted as an alias with the same partial semantics. The response never includes the signing_secret. Requires webhooks:write.

Path parameters

Name	Type	Description
`id`required	integer	Webhook subscription id. Scoped to the calling api_client.

Request body

application/json · WebhookSubscriptionUpdateRequest · required

The fields to change. Omitted fields keep their current value.

url string (uri)
event_filter array of WebhookEventName
active boolean

Subscribe to fewer events

{
  "event_filter": [
    "adverse_action.completed"
  ]
}

Pause the subscription without deleting it

{
  "active": false
}

Move the subscription to a new URL

{
  "url": "https://hooks.partner.example/cascades/v2"
}

Responses

200 Updated (no signing_secret) application/json

data WebhookSubscription

Schema: WebhookSubscription
- id integer
- object string
- url string
- event_filter array of WebhookEventName Empty = subscribed to ALL events.
- active boolean
- last_delivered_at string (date-time), nullable
- created_at string (date-time)
- updated_at string (date-time)
meta Meta

Schema: Meta
- request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.

200 example

{
  "data": {
    "id": 1,
    "object": "webhook_subscription",
    "url": "https://hooks.partner.example/cascades",
    "event_filter": [
      "execution.completed"
    ],
    "active": true,
    "last_delivered_at": "2026-05-08T18:41:05Z",
    "created_at": "2026-05-08T18:41:05Z",
    "updated_at": "2026-05-08T18:41:05Z"
  },
  "meta": {
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f"
  }
}

401 Missing, malformed, expired or revoked bearer token. The WWW-Authenticate header carries the RFC 6750 challenge. application/json

Schema: ErrorEnvelope

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "A valid bearer token is required.",
    "details": [],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/unauthorized"
  }
}

403 Token does not hold the required scope. details lists the scope(s) that were checked. application/json

Schema: ErrorEnvelope

403 example

{
  "error": {
    "code": "insufficient_scope",
    "message": "This token does not have the required scope.",
    "details": [
      {
        "field": "scope",
        "message": "executions:write"
      }
    ],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/insufficient_scope"
  }
}

404 Resource does not exist or belongs to another tenant / api_client application/json

Schema: ErrorEnvelope

404 example

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "details": [],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/not_found"
  }
}

422 Request body or params failed validation application/json

Schema: ErrorEnvelope

422 example

{
  "error": {
    "code": "validation_failed",
    "message": "The request could not be processed.",
    "details": [
      {
        "field": "execution_mode",
        "message": "must be test or live"
      }
    ],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/validation_failed"
  }
}

429 Rate limit exceeded (60 req/min per IP on /api/v1, 600 req/hour per token prefix, or 300 req/5 min per IP globally). The body is the standard error envelope and Retry-After gives the seconds until the window resets. application/json

Schema: ErrorEnvelope

429 example

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry later.",
    "details": [],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/rate_limited"
  }
}

Markdown version · OpenAPI

Path parameters

Request body

Responses

Related