API ReferenceProjects

Refresh webhook secret

Generates a new webhook secret for the project, invalidating the previous one. Webhook secrets are used to verify the authenticity of incoming webhook payloads through signature verification. This endpoint should be used when you need to rotate your webhook secret for security purposes. After refreshing, you must update your webhook verification logic to use the new secret.

Headers

x-api-keystringRequired

Response

Webhook secret refreshed successfully. The new secret is returned in the response and should be used for webhook signature verification.
successboolean
Indicates if the webhook secret was successfully refreshed
messagestring

Human-readable description of the refresh operation result

webhook_secretstring
The new secret key that should be used to verify incoming webhook payloads

Errors