POST
/
documents
/
v1
/
webhooks

You can configure webhooks to receive notifications when a Document Parsing or Extraction Job is complete.

This allows you to submit document parsing and extraction jobs, and get notified when they are complete.

We use a third party service, Svix, to deliver these webhooks. Your data is not shared with Svix. The notification event contains your job ID, which you can use to retrieve the results of the job with your API key.

You can call this API multiple times to update your webhook endpoints or to enable/disable the webhook.

{
  "job_id": "job-XXX",
  "status": "completed",
}

The job_outcome can be success, failure, or error.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
url
string
required

Was this page helpful?