Request headers · 1
Authentication.
Authorizationstringrequired
Production API key. Pass it as Bearer ax_live_…
Returns · 200
The standard { data, meta } envelope. data contains an array of WebhookOut.
Envelope
dataWebhookOut[]
Array of result objects.
metaMeta
Pagination and request metadata, including request_id, data_as_of, and ontology_version.
WebhookOut
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).
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.