Help CenterGitHub

Rotate webhook secret

Generates a new signing secret for a webhook endpoint, invalidating the old secret.

Parameters

Path Parameters

id string Required
Webhook endpoint ID

Request Body

name string
Friendly name for the webhook endpoint.
url string
URL that receives the webhook POST requests. HTTPS is strongly recommended but not enforced.
event_types array
Events to subscribe to. Replaces the existing list.
is_active boolean
Whether the webhook is active.
retry_attempts number
Retry attempts on failure (0-10).
timeout number
Request timeout in seconds (5-60).
auth_type string (none | basic | bearer | custom)
Authentication method for your endpoint.
auth_config object
Credentials for auth_type: username/password, token, or header_name/header_value.
custom_headers object
Additional HTTP headers sent with each delivery.

Returns

200 Secret rotated successfully
401 Authentication required
404 Webhook not found

Related

Webhooks
PUT/api/v1/webhooks/[id]