Webhooks

Create a webhook endpoint

Changed on

Creates an enabled Board-owned webhook endpoint and returns the signing secret once. The endpoint immediately receives the selected supported V1 event types. 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

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/webhook-endpoints
  • Auth: HTTP bearer

Request body

urlstring uri required

Public HTTPS URL that will receive webhook deliveries.

event_typesstring[] required

V1 event types this endpoint subscribes to (unique).

Response

Endpoint created; 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