Delivery webhooks

Update, disable, re-enable or rotate

Setting active: true on a disabled endpoint also clears its failure history — otherwise it would be disabled again by its past rather than by anything it did after the fix.

brandId is fixed at creation: delete and re-create to change scope. Unknown fields are rejected rather than ignored.

patch/v1/webhooks/{id}

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook id.

Request body

urlstring
eventsstring[]
descriptionstring nullable
activeboolean

false pauses delivery; true resumes and clears the failure count.

rotateSecretboolean

Issues a new signing secret and returns it once. The previous one stops verifying immediately.

Response

Updated. Carries secret only when rotated.

idstring required
urlstring required

Your https:// endpoint.

eventsstring[] required
brandIdstring nullable

Null means every brand on the account.

descriptionstring nullable
activeboolean required

False once disabled, whether by you or by repeated failure.

createdAtstring
secretstring

Only present when rotateSecret was true.

notestring

Changes

No recorded changes to this operation across all 1 revision of this API.