Webhooks for Monitoring Alerts (Alpha) ​

⚠️ Alpha: Please note webhooks are in an early stage of development and are subject to change.

Purpose ​

Our Monitoring Alert webhooks have been created to trigger a webhook whenever an Alert is generated from our ongoing Monitoring system. This will enable you to utilise any downstream automation, notifications, emails etc. whenever an Alert is generated on a Case you have configured.

Getting Set Up ​

Our Webhooks are an important new feature of Case Management, in order to make use of them you will need to ensure:

1. You are using our Case Management system.
2. You have informed us of the callback URL you are listening on.

To establish either of these you can reach out to our Support team who can help you get started.

Sample Payload ​

The webhook consists of an HTTP POST call with an application/JSON payload.

Custom headers.

{
    "id": "8e07475a-d00d-4d4e-b1cf-94d76922c24d",
    "caseId": "597d2eb0-83d4-452d-9fea-06723bbb8bab",
    "resultDate": "0001-01-01T00:00:00",
    "numberOfAlerts": 2,
    "alerts": 
      [
        {
          "alertId" : "729834502",
          "profileId" : "SANC-5612de4b-45ed-3f88-955f-8978523io4h5",
          "serviceName" : "SISPlusCheck",
          "source" : "Specially Designated Nationals List",
          "datasourceRecordName" : "David Cameron",
          "status" : "Open",
          "nameMatchScore" : "100",
          "dobMatchScore" : "100"
        },
        {
          "alertId" : "23457024"
          ...
        }
     ]
}

Field Breakdown ​