Webhook Payload
ConceptsThe webhook payload is the JSON body that DocLD sends to your configured URL when a webhook event occurs. It typically includes the event type (e.g., document.processed, extraction.completed), resource identifiers (job ID, document-id), timestamps, and any event-specific data. Your server should parse the payload, verify the request (e.g., signature if supported), and act on the event (e.g., poll for results or update your system).
Common Fields
- Event type — Identifies what happened (e.g., job completed, workflow run finished).
- Resource IDs — Job ID, document ID, workflow run ID so you can fetch details via the API.
- Timestamp — When the event occurred.
Handling webhook payloads enables event-driven integrations without polling. Idempotency on your side helps when the same event is delivered more than once.
Related Concepts
Webhook payloads are sent by webhooks when events occur. They reference jobs, workflow runs, and other resources. Use the API to fetch full details if needed.