POST/organizations/{organizationId}/webhooks

Create a webhook subscription

Registers an HTTPS endpoint for selected events and returns the signing secret once.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenBearerAuthoptional

Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/jsonrequired

urlstring · urirequired

descriptionstringoptional

eventsarray<string>required

metadataobjectoptional

Responses

201application/json

Subscription created.

{
  "id": "whk_01J8FD1M5T7Q9P2V4K6",
  "url": "https://hooks.acme.example/heyo",
  "description": "Acme production event receiver",
  "events": [
    "contact.created"
  ],
  "status": "active",
  "signing_secret_last4": "4K6Z",
  "delivery_health": {
    "success_rate": 99.5,
    "failed_last_24h": 1,
    "last_delivery_at": "2026-09-03T11:05:00Z"
  },
  "created_at": "2026-06-17T12:12:00Z",
  "signing_secret": "whsec_demo_01J8FG8N2P5Q7T4V6M9"
}

422

Webhook URL or event names are invalid.

curl --request POST \ 'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/webhooks' \ --header 'Idempotency-Key: 5ba89923-8c6d-44a3-9ab7-2fbbdb865f9a' \ --header 'Content-Type: application/json' \ --data '{ "url": "https://hooks.acme.example/heyo", "description": "Acme production event receiver", "events": [ "contact.created", "document.published", "export.failed" ], "metadata": { "team": "platform", "service": "event-ingest" }}'

{ "id": "whk_01J8FD1M5T7Q9P2V4K6", "url": "https://hooks.acme.example/heyo", "description": "Acme production event receiver", "events": [ "contact.created" ], "status": "active", "signing_secret_last4": "4K6Z", "delivery_health": { "success_rate": 99.5, "failed_last_24h": 1, "last_delivery_at": "2026-09-03T11:05:00Z" }, "created_at": "2026-06-17T12:12:00Z", "signing_secret": "whsec_demo_01J8FG8N2P5Q7T4V6M9"}