v1

latestOpenAPI 3.0.3Proprietary2026-07-244065126.5 KB
Webhooks

Get Sample Payload for Webhook

Returns a sample payload matching the webhook's configured event type. The payload uses static example data and includes 'test': true. Fundamental events (clientview_updated, incremental_update, series_updated) carry a 'series' field; document_added carries a 'document' object instead. Only the webhook owner can access this endpoint.

get/api/v2/webhooks/{webhook_id}/sample-payload

Path parameters

webhook_idinteger required

The ID of the webhook

Response

testboolean
event_typestring
company_idinteger
seriesobject

Present for fundamental events.

documentobject

Present for document_added events. Carries the document's raw filing_type and document_type exactly as returned by GET /documents (no normalization).