Webhooks

Rotate a webhook endpoint secret

Changed on

Issues a new signing secret (returned once) and keeps the previous secret verifiable for a bounded overlap window. The secret is returned only on the original response and is not replayed by an idempotent retry — recover a lost secret by rotating.

post/webhook-endpoints/{id}/rotate-secret

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/webhook-endpoints/{id}/rotate-secret
  • Auth: HTTP bearer

Path parameters

idstring required

The webhook endpoint ID.

Response

Secret rotated; new secret returned once.

idstring required
object'webhook_endpoint' required
urlstring required
event_typesstring[] required
status'enabled' | 'paused' | 'failing' required
failure_streakinteger required
last_failure_atstring nullable required
last_success_atstring nullable required
health_changed_atstring nullable required
health_reason'consecutive_failures' | 'retry_exhausted' | 'http_410' | 'operator_pause' | 'operator_resume' | 'synthetic_recovery' nullable required
secret_overlap_expires_atstring nullable required
created_atstring required
updated_atstring required
secretstring required

Signing secret returned exactly once on create or rotate. Store it immediately.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status