API for Real-Time Results Collection via Webhooks
What are webhooks?
Webhooks are automated notifications sent from one platform to another when a specific event occurs. When a trigger event occurs in the trigger platform, the platform collects the relevant data and sends it to the predefined action platform's webhook URL. The action platform then uses this data to perform any specific task based on the information received from the trigger platform.
In case of Haut.AI SaaS:
Haut.AI SaaS platform is the trigger platform that sends the data.
Completion of photo processing is a trigger event.
The results of the Algorithms and Survey answers are the data.
Your 3rd party platform is an action platform.
Webhooks are very common for connecting different systems with a real-time data exchange.
When webhooks are triggered?
Webhooks are triggered every time any Algorithms Application finishes calculation on image.
Based on the number of applications, attached to the Dataset, the number of webhooks received when image is fully processed may vary.
How do webhooks payload looks?
Here are some examples. Please, keep in mind that the documentation may not represent information always up to date, and the file is subject to change:
Application FaceMetrics 2.0 returns webhook like this:
Application Recommendation Engine returns webhook like this:
How to configure webhook?
You can configure the WebHook - an endpoint on your server where to event will be fired when image has been processed. This event will contain JSON body with parameters you will need to make request for image results. To configure WebHook please go to DataSet -> Settings in SaaS Portal as on image below and enter endpoint. For testing we would recommend to use https://requestbin.com/ free service.
Last updated
