Docs/Reference/Webhooks/Create Webhook
POST/v1/webhooksTier · Developer

Create Webhook

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Request body · 2

JSON request body fields.

urlstringrequired
eventsstring[]required

Returns · 200

The standard { data, meta } envelope. data contains WebhookCreateOut.

Envelope

dataWebhookCreateOut

A single result object.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

WebhookCreateOut

idinteger

Webhook ID.

urlstring

HTTPS URL that receives webhook deliveries.

eventsstring[]

Subscribed event types (e.g. ['new_filing', 'amendment']).

activeboolean

Whether the webhook is currently active.

created_atstring

When the webhook was created (ISO 8601).

secretstring

HMAC-SHA256 signing secret (64 hex chars). Shown once.

Errors

Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.

Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.