Ongoing monitoring webhooks | API

Created by Tomas Gibbons, Modified on Fri, 16 Aug, 2024 at 12:44 PM by Hannah Rowe

 

Ongoing monitoring alert webhooks are used to call back to external systems with a notification when an ongoing monitoring alert is triggered.


 

Configuring your webhook URL 
 

The ongoing monitoring alert webhook URL is set per Credas portal and must be set by your technical contact. 


We recommend that you have a specific webhook URL for ongoing monitoring alerts to ensure these are easily identifiable. 


Resellers can set this webhook URL value within Credas child portals.


 

JSON example 

 

A HTTP post will be sent to the configured webhook URL on completion of the process. 

 

An example of the JSON post body is below.


{
    
"EntityId": "7e52b328-86bd-463b-b322-104ae4bcf836",
    "ClientId": "2a393035-e203-4e16-bbad-5d829955dfcb"
}


The entityId included within this POST body will allow you to identify the specific individual that has triggered an ongoing monitoring alert.

 

 

Example use case


Our ongoing monitoring alert webhook is commonly used to provide a notification where an ongoing monitoring alert is triggered within the Credas system.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule