Skip to main content

Webhook Integration

Connecting to a webhook endpoint​

info

You need a Cradl AI Model to follow these steps. How to create an AI Model.

With webhooks you can automatically receive extracted data in JSON format, and it only takes a few clicks to set up. Select Webhook from the list of Export options:

Screenshot of the list of export destinations inside the Cradl AI application

Paste your webhook endpoint into the Endpoint URI, and save. You're now connected to your endpoint.

Screenshot of the list of the URI input field inside the Cradl AI application

To quickly test your connection, go to Webhook.site and paste your unique, auto-generated endpoint into your webhook URI field. Upload a document in Cradl AI, validate it, and then inspect the JSON payload directly on Webhook.site.

Image

Request and JSON payload​

Cradl AI sends a POST request to your specified webhook endpoint whenever a document is validated in Cradl AI. The request includes a JSON payload containing the extracted values and various metadata.

JSON payload of an invoice example:

{
    "documentId": "las:document:50ac981adbde44c6a774bc1fb633041c",
    "datasetId": "las:dataset:7141211528ab43749ca628e7aff175fc",
    "values": {
        "due_date": "2023-05-17",
        "invoice_date": "2023-05-04",
        "invoice_id": "138",
        "supplier_name": "Logoipsum Inc.",
        "total_amount": "534.68",
        "vat_amount": "39.68",
        "rotation": "0",
    },
    "validatedPredictions": {
        "due_date": {
          "automated": true,
          "confidence": 0.99,
          "isEdited": false,
          "pages": [
            0
          ],
          "rawValue": "May 17th, 2023",
          "value": "2023-05-17"
        },
        "invoice_date": {
          "automated": true,
          "confidence": 0.99,
          "isEdited": false,
          "pages": [
            0
          ],
          "rawValue": "May 4th, 2023",
          "value": "2023-05-04"
        },
        "invoice_id": {
          "automated": true,
          "confidence": 0.99,
          "isEdited": false,
          "pages": [
            0
          ],
          "rawValue": "138",
          "value": "138"
        },
        "supplier_name": {
            "automated": true,
            "confidence": 0.99,
            "isEdited": false,
            "pages": [
                0
            ],
            "rawValue": "Logoipsum Inc.",
            "value": "Logoipsum Inc."
        },
        "total_amount": {
          "automated": true,
          "confidence": 0.99,
          "isEdited": false,
          "pages": [
            0
          ],
          "rawValue": "534.68",
          "value": "534.68"
        },
        "vat_amount": {
          "automated": true,
          "confidence": 0.99,
          "isEdited": false,
          "pages": [
            0
          ],
          "rawValue": "39.68",
          "value": "39.68"
        },
    },
    ...,
}