Webhooks

Webhooks provide a way to notify Navigator API clients of events that occur in within the Navigator product.

A guide is provided for explaining the setup process in the Navigator dashboard.

Why use webhooks?

When a new analysis for a subject is created, it can take some time to process the transactions and produce the analysis results. To avoid having to call the API periodically to check on the status, a webhook can be set up that is called once the status of the analysis changes (on completion, for instance).

Request format

A webhook request is done from the Navigator using a POST request to your desired URL (see the guide for how to setup the webhook URL). The following section describes the body format of the request.

Event format

The event contains the type of the event as well as associated data. A full list of events is provided.

1
2
3
4
5
6

{
    "type": "<event_name>",
    "data": {
        ...
    }
}