webhook_endpoints

Create a webhook endpoint (returns the one-time whsec_ secret)

Standard Webhooks signing (webhook-id / webhook-timestamp / webhook-signature). The secret appears ONLY in this response. Delivery contract: 10s timeout, retries 1m/5m/30m/2h/8h/24h with jitter, at-least-once, no ordering — dedupe on the evt_ id. Endpoints failing 100% for 72h are auto-disabled with an email notice. At most 10 endpoints per account.

post/v1/webhook_endpoints

Request

  • Base URL: https://api.primateintelligence.ai
  • URL: https://api.primateintelligence.ai/v1/webhook_endpoints
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

§16.1: first request wins; 24h replay window; same key + different body → 409 idempotency_key_reused.

Request body

urlstring uri required

HTTPS delivery URL.

eventsWebhookEventType[] required

Subscribed event types — a non-empty subset of the closed v1 vocabulary.

descriptionstring

Response

Endpoint created. secret is returned exactly once.

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.