webhooks

Update a webhook subscription — url, event filter, active flag, or rotate the secret.

At least one of url, eventTypes, secret, or active must be present. active:true re-enables a subscription the delivery pump auto-disabled after 5 consecutive terminal failures; active:false pauses delivery without deleting. Rotating the secret returns it once in the response.

put/webhook-subscriptions/{id}

Request

  • Base URL: https://api.coldrig.dev
  • URL: https://api.coldrig.dev/webhook-subscriptions/{id}
  • Auth: HTTP bearer

Request body

urlstring
eventTypesWebhookEventType[]
secretstring

Rotates the signing secret; the new value is returned once in the response.

activeboolean

Set false to pause delivery without deleting; set true to resume (also re-enables an auto-disabled subscription).

Response

Subscription updated.

idstring required
urlstring required
eventTypesWebhookEventType[] required
activeboolean required
status'active' | 'disabled' required
disabledReasonstring nullable required
consecutiveFailuresinteger required
createdAtinteger required
updatedAtinteger required
secretstring

Present only when this update rotated the secret; shown once.

Changes

No recorded changes to this operation across all 2 revisions of this API.