Set Up Webhooks to Receive Document Status Updates

Using Webhooks to Get Document Status Updates

🔔 Get Automatic Updates When Your Document Is Ready

Want to receive real-time updates when your documents are processed? Use webhooks to automatically notify your system when a file is complete.


🔑 Generate Your Webhook Secret Key

  1. Go to Settings > API Integration

  2. Under Generate Webhook Secret Key, click Generate secret key

  3. This key is used to sign and validate incoming webhook notifications

Keep your key secure. If you regenerate it, make sure to update it in your webhook handling system.


🔧 Set Up a Webhook via the API

To start receiving document completion events, use the Webhooks section in Settings > API Documentation.

🔹 Create a Webhook

POST /v1/admin/company/webhooks

Body example:

body example

  • The url must be a secure HTTPS endpoint that can accept POST requests.

  • The event should be "file_processed" (for now, this is the available event).

🔹 List All Webhooks

GET /v1/admin/company/webhooks
Returns the list of webhooks already configured in your company account.

🔹 Delete a Webhook

DELETE /v1/admin/company/webhooks/{id}
Use this endpoint to remove a webhook using its ID.

✅ Use Case Example

Once your webhook is registered, you’ll receive a POST request when a document’s processing is complete.
Example response:

Make sure your endpoint can handle and verify the request using your Webhook Secret Key.