You can use webhooks to get notified about the status of Document Ingestion Jobs.

Webhooks are configured on a per-project basis. The project associated with the API key that is being used to configure the webhook is the one for which the webhook will be triggered.

Our webhooks events are managed by Svix, please note none of your data is sent to Svix, only event statuses.

​
Create and Configure Your Webhook

To use Webhooks with Tensorlake, make sure you have created a project on Tensorlake Cloud.

It is important to disable CSRF protection for the endpoint if the framework you use enables them by default.

1

Create a webhook

Go to the project that you want to create the webhook for, and click into the Webhooks tab.

Only admins for a project can create webhooks. However, members of a project can view webhooks.
2

Set up your webhook

Give the webhook a name, and provide a URL that you control.

3

Configure access for your webhook

Configure your webhook by selecting the event types that you want to listen to.

The three event types are:

  1. Document Parse Job Creation: Triggered when Tensorlake receives the request to parse a document and kicks off the parsing.
  2. Document Parsing Failed: Triggered when a parsing job fails.
  3. Document Parse Completed: Triggered when a parsing job succeeds.

​
Secure your Endpoints with Signature Verification

Webhook signatures let you verify that webhook messages are actually sent by Svix, which is how Tensorlake webhooks are sent. Without verification, forged webhooks can be sent to your endpoint.

Review these svix documentation to ensure you’re endpoint remains secure and is only receiving valid webhooks from Tensorlake via svix:

​
Understand the Webhook Payload

The following payload is sent to your configured webhook URL when a job finishes.

{
    "job_id": "job_XXXX",
    "status": "success",
    "dataset": "dataset_XXXX",
}

If a Parse job is created without a dataset, the dataset field will be null. The possible statuses are:

  • created - The job is created.
  • success - The job finished successfully.
  • failure - The job failed to finish.

​
Test Your Webhooks in Tensorlake Cloud

We have a UI to test webhooks. After creating a webhook, select on the event type you want to test.