Rename a Webhook, change its enabled state, or rotate its secret

Session-gated; requires app:write on the webhook's app. Re-enable is {enabled: true} — not a separate action — and resets the consecutive-failure counter. {rotate_secret: true} replaces the secret immediately and returns the new one once. name relabels the Webhook.

patch/api/v1/webhooks/{webhookId}

Request

  • Base URL: https://charm.ing
  • URL: https://charm.ing/api/v1/webhooks/{webhookId}
  • Auth: HTTP bearer

Request body

enabledboolean
rotate_secretboolean
namestring

Response

Webhook updated. secret is present only after a rotation.

oktrue required
secretstring

Present only when the update rotated the secret. Shown once.

Changes

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