Make Real-Time Data Connection with External Platforms via Webhooks
This section describes different options of Haut.AI integration with external platforms via webhooks
Integration with external platforms via webhooks is available for all plans.
When integration with external platforms is needed?
There are several use cases when integration with 3rd party platforms could be helpful. For example,
You might want to use the Skin Consultant App widget for lead generation and remarketing.
You might want to use the Skin Consultant App widget to enrich or update your existing customers' profiles with data about their skin concerns.
In any case, our software allows to build the necessary data transfer to a 3rd party platform:
The Surveys in Skin Consultant App can be used to collect customers' data—such as name, email, birthday, etc.—for marketing purposes.
The Algorithms results can be collected when the image is fully processed.
Both these data objects can be sent to 3rd party platforms (like CRM or marketing email platforms) by using 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.
Haut.AI offers two options to consume webhooks:
Via Zapier - a tool that helps you automate repetitive tasks between two or more apps. This option does not require coding but requires having an active Zapier account with the correct plan. Start by following our guides on how to integrate 3rd party platforms with Haut.AI SaaS via Zapier.
Via custom webhook integration directly to 3rd party platforms. This option requires custom code to be executed on the side of the 3rd party platform, which should support the webhooks option. Follow this section.
Integration using Zapier
In most cases, platforms like CRMs or email marketing platforms require emails and names of your customers to populate the profile. In order to collect this data, please follow these steps first:
Step 1: Add your Terms and Conditions document to your Skin Consultant App.
See our guide on how to upload your Terms and Conditions into the Skin Consultant App.
Please note that in most countries, data like emails or phone numbers is considered "personal data."
This means that you are legally required to have your Terms and Conditions in your Skin Consultant App, and sometimes you are legally required to receive acceptance of your Terms and Conditions from your customers.
Therefore, we do not recommend skipping this step.
Please note that the Skin Consultant App currently does not allow end users to explicitly accept your Terms and Conditions.
This feature will be added soon.
Step 2: Set up a Survey
Set up a Survey to collect all necessary data from your customers to ensure that your third-party platform integration works can handle the received information correctly and match new data with correct customer profiles on 3rd party platform.
See our general guide on how to set up a Survey in the Skin Consultant App.
You might need to create at least two questions of type "Text Input" - email and name, see example screenshot below:
Please be sure to correctly parse your questions into your CRM, as Question text can be any text.
Please note that the Skin Consultant App Surveys currently do not verify the correctness of the format of entered emails and phone numbers, the fields currently support only plain text input (type "Txt input")
This feature will be added soon.
Step 3: Integrate webhooks into 3rd party action platform—Zapier
Follow the example and feel free to adjust it to your use case:
See our example of how to Integrate Haut.AI SaaS with Klaviyo via Zapier to pass into Klaviyo survey answers and metrics values.
To use webhooks in Zapier, you need a "Professional" plan on Zapier or higher.
You can check Zapier plans and pricing here: https://zapier.com/pricing.
Integration without Zapier—direct usage of webhooks in 3rd party platform
You can use webhooks directly (without Zapier) to integrate with any 3rd party platform that supports webhooks directly. Please follow the documentation for developers for more details - Webhooks Developer Docs.
FAQ
Why do we recommend Zapier?
The main benefit of Zapier is that this tool supports a wide variety of third-party platforms with which to integrate. It allows data transformation and modification with nearly no code, making integrations with third-party platforms smoother and easier.
What exact data can I expect to get from webhooks?
By default, webhook integration returns data for each Algorithm Application, attached to the Dataset. Optionally, it can return Survey Answers: to activate this you should set "Add survey answers to webhook" in the webhook configuration settings in Dataset (see an example for Klaviyo integration).
To learn how the webhooks payload looks, please check the Webhooks Developer Docs.
If your Dataset is connected to Skin Consultant App, it means that there are 2 Algorithm Application running on each image:
Application “FaceMetrics 2.0” will return one
webhookwhen ALL metrics are calculated.Application “Recommendation Engine” returns one
webhookwhen products are matched.If you select "Merge webhooks" in dataset settings, you will receive one
webhookfor with the results from all applications.
Last updated
