Overview

We make use of Webhooks to let you know when the data you've requested is importing and when it's ready for you to access. The main benefit of this is to keep your system up to date without having to poll for changes.

Details

Our Webhook processor is built on top of Azure EventGrid to allow us to provide a comprehensive and reliable experience.

You can register your webhook URL in the Partner Dashboard for your application.

Examples

Below is an example of a webhook message. The payload is inside a section called data. In here you will find the ClientId of your application, the TenantId of the data that the message is referring to and a WebHookMessageType value.

{
    "id":"df7377b9-4279-4113-aeda-d63940734242", //Unique Id of the message
    "subject":"e9e1e94a-63a3-4c69-991e-8e207d9b5c05", //The ClientId of your application
    "data":
    {
        "ClientId":"e9e1e94a-63a3-4c69-991e-8e207d9b5c05", //The ClientId of your application
        "TenantId":"e1add698-2aef-e1c2-ca09-79ee4d1d9ef9", //The TenantId of the dataset that this message is about
        "Subject":"e9e1e94a-63a3-4c69-991e-8e207d9b5c05", //The ClientId of your application
        "WebHookMessageType":1, //The type of message (see below)
        "DataId":null,
        "Timestamp":"2022-05-19T22:22:00.3861035Z", //When the message was originally sent
        "MessageName":"WebHookNotification", 
        "PromotedProperties":null
    },
    "eventType":"WebHookNotification",
    "dataVersion":"1",
    "metadataVersion":"1",
    "eventTime":"2022-05-19T22:22:00.3861035Z",
    "topic":"/subscriptions/aa5a955c-bfd6-43a4-8136-58586adce400/resourceGroups/ls-prod/providers/Microsoft.EventGrid/topics/ledgerflowgrid"
}

The message types are as follows:

1 - Data Ready

The data has been imported / refreshed and is ready for querying

2 - Download Scheduled

We have scheduled this data to be downloaded

3 - Download Started

We have started downloading this data

4 - Import Started

We have started processing and converting the data

5 - Lost Source Authentication

You will need to request that the customer re-authenticates the organisation as our credentials are no longer valid

6 - Data Reset

You will need to do a full re-sync of the data after receiving this webhook. The Ids for some transactions or other entities could have changed so a differential sync may cause issues