webhook_endpoints

Rotate the signing secret (24h dual-secret overlap)

Returns the NEW secret exactly once. The previous secret keeps signing deliveries for 24h so receivers can migrate without dropped verifications — the signature header carries one signature per active secret.

post/v1/webhook_endpoints/{id}/rotate_secret

Request

  • Base URL: https://api.primateintelligence.ai
  • URL: https://api.primateintelligence.ai/v1/webhook_endpoints/{id}/rotate_secret
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook endpoint id (we_…).

Response

Endpoint with the new one-time secret.

idstring required

Webhook endpoint id (prefixed ULID).

object'webhook_endpoint' required
urlstring uri required
eventsWebhookEventType[] required
descriptionstring nullable required
status'enabled' | 'disabled' required
disabled_reason'auto_failure' | 'user' nullable required

auto_failure = 72h of 100% delivery failure (§16.3). Re-enable via POST …/enable.

secretstring

Signing secret — returned EXACTLY ONCE (create / rotate_secret), never readable again.

last_success_atstring date-time nullable required
created_atstring date-time required

Example response

{
  "id": "we_01KX12XX3BNM688AWHX7406HCF",
  "last_success_at": "2026-07-08T14:00:00Z",
  "created_at": "2026-07-08T14:00:00Z"
}

Changes

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