V7 Darwin

V7 Resources & Documentation

Welcome to the V7 resources & documentation hub. You'll find comprehensive guides and documentation to help you start working with V7 Darwin as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Webhook allows your application to receive updates in realtime when certain events occurs on Darwin. This is usually faster than polling for updates.

We are currently building out support for more event types, if you are not seeing an event you need in the list below, please reach out to us and we might be able to prioritize it.

Event type

Description

Payload

workflow_complete

Triggered when an item in a dataset changed into the complete status.

dataset_id
filename
annotations

Life cycle

When an event is generated on Darwin, the system looks for any webhooks that are associated with the current dataset and event type. This webhook (which is an URL) will then receive a POST request containing the event_type + payload. Darwin expects an empty 2XX reply, any other return code will be considered an error and might lead to a retry of the event a few minutes later.

{  
    "event_type": "workflow_complete",
    "payload": {
        "dataset_id": 1,
        "filename": "letter.png",
        "annotations": [
            {
                "class_name": "FROM",
                "data": {
                    "bounding_box": {
                       "x": 455,
                       "y": 300,
                       "w": 100,
                       "h": 20
                    },
                    "text": {
                        "text": "Mail office"
                    }
                }
            }
        ]
    }
}

See https://docs.v7labs.com/reference/darwin-json for details on the annotation format.

📘

Multiple webhooks

There might be several webhooks applicable for an event, in that case each webhook will be fired.

Updated 2 months ago

Webhooks


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.