Sign in
latestOpenAPI 3.1.0Proprietary - Prezent, Inc.2026-08-114675175.5 KB

a01cb764a085

Webhooks

Create a webhook subscription

Registers a new HTTPS endpoint to receive signed delivery callbacks for the listed event types. Returns the HMAC secret ONCE — store it securely. Subsequent reads only expose the secret_prefix.

post/api/v1/webhook-subscriptions

Request body

urlstring uri required

HTTPS endpoint to receive deliveries. Must use https://, resolve to a public IP, and not use a disallowed port. See the Webhooks guide.

eventsWebhookEventType[]

Event types to subscribe to. Defaults to ["*"].

descriptionstring nullable
status'active' | 'disabled'

active subscriptions receive deliveries. disabled subscriptions are skipped at dispatch time — either explicitly set by the customer or set by Prezent's auto-disable rule after 50 consecutive delivery failures. PATCH status: active to re-enable.

Example request

{
  "url": "https://hooks.example.com/prezent",
  "events": [
    "autogeneration.completed",
    "autogeneration.failed"
  ],
  "description": "Push completions into our deal-room worker."
}

Response

Subscription created. Body contains the secret — the only response that ever exposes it.

successboolean

true on success (omitted by some legacy handlers).

Example response

{
  "data": {
    "id": "whsub_3f7a9b1c8d2e4f5a6b7c8d9e0f1a2b3c",
    "url": "https://hooks.example.com/prezent",
    "secret_prefix": "whsec_",
    "events": [
      "autogeneration.completed",
      "autogeneration.failed"
    ],
    "description": "Push completions into our deal-room worker.",
    "secret": "whsec_4mZkV8t9oFp1qR3sT7uW9xY2zA5bCdEfGhI"
  }
}