> For the complete documentation index, see [llms.txt](https://docs.saas.haut.ai/haut.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.saas.haut.ai/haut.ai/haut.ai-features/consumer-apps/make-real-time-data-connection-with-external-platforms-via-webhooks.md). # Make Real-Time Data Connection with External Platforms via Webhooks This section describes different options of Haut.AI integration with external platforms via webhooks {% hint style="success" %} Integration with external platforms via webhooks is available for **all** plans. {% endhint %} ## 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 [Consumer App](/haut.ai/haut.ai-features/consumer-apps.md) widget for lead generation and remarketing. * You might want to use the [Consumer App](/haut.ai/haut.ai-features/consumer-apps.md) 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: 1. The [Surveys in Consumer App](/haut.ai/haut.ai-features/consumer-apps/add-and-customize-survey-into-consumer-app.md) can be used to collect customers' data—such as name, email, birthday, etc.—for marketing purposes. 2. The [Algorithms](/haut.ai/haut.ai-features/algorithms.md) results can be collected when the image is fully processed. 3. Both these data objects can be sent to 3rd party platforms (like CRM or marketing email platforms) by using [webhooks](#what-are-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](/haut.ai/haut.ai-features/algorithms.md) and [Survey](/haut.ai/haut.ai-features/consumer-apps/add-and-customize-survey-into-consumer-app.md) 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: 1. Via [Zapier](https://zapier.com/) - 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.](#integration-with-the-external-platforms-using-zapier) 2. 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-without-zapier-direct-usage-of-webhooks-in-3rd-party-platform). *** ## 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 Consumer App See our guide on how to [upload your Terms and Conditions into the Consumer App](/haut.ai/quick-start-guides/no-code-app-for-e-commerce-businesses/create-consumer-app.md#attaching-terms-and-conditions-for-end-users). {% hint style="danger" %} 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 Consumer 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. {% endhint %} {% hint style="info" %} To require end users to explicitly accept your Terms and Conditions before they proceed, check the `Require user agreement before proceeding` checkbox when you upload the documents. See [Attaching terms and conditions and privacy policy for end-users](/haut.ai/quick-start-guides/no-code-app-for-e-commerce-businesses/create-consumer-app.md#attaching-terms-and-conditions-and-privacy-policy-for-end-users). {% endhint %} ### 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 Consumer App](/haut.ai/haut.ai-features/consumer-apps/add-and-customize-survey-into-consumer-app.md). You might need to create at least two questions of type "Text Input" - email and name, see example screenshot below:

Interface of Consumer App settings with 3 questions added, all are with Text Input type

{% hint style="info" %} Please be sure to correctly parse your questions into your CRM, as Question text can be any text. {% endhint %} {% hint style="info" %} To collect a validated email address or phone number, use the dedicated **Email** and **Phone number** question types rather than plain text input. See [supported-question-types](/haut.ai/haut.ai-features/consumer-apps/add-and-customize-survey-into-consumer-app.md#supported-question-types). {% endhint %} ### Step 3: Integrate webhooks into 3rd party action platform—[Zapier](https://zapier.com/) 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](/haut.ai/haut.ai-features/consumer-apps/make-real-time-data-connection-with-external-platforms-via-webhooks/example-of-haut.ai-saas-integration-with-klaviyo-via-zapier.md) to pass into Klaviyo survey answers and metrics values. {% hint style="info" %} To use webhooks in Zapier, you need a "Professional" plan on Zapier or higher. You can check Zapier plans and pricing here: . {% endhint %} *** ## 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.](/haut.ai/developers/deprecated-developer-guide/api-for-real-time-results-collection-via-webhooks.md) *** ## FAQ ### Why do we recommend Zapier? The main benefit of [Zapier](https://zapier.com/) 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](/haut.ai/haut.ai-features/algorithms.md), 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](/haut.ai/haut.ai-features/consumer-apps/make-real-time-data-connection-with-external-platforms-via-webhooks/example-of-haut.ai-saas-integration-with-klaviyo-via-zapier.md#set-up-and-configure-webhook-in-zapier)). To learn how the webhooks payload looks, please check the [Webhooks Developer Docs.](/haut.ai/developers/deprecated-developer-guide/api-for-real-time-results-collection-via-webhooks.md) Each payload includes an images object containing signed URLs. These signed URLs are temporary and will expire 1 hour after generation. ```json { "images": { "original": { "signed_url": "https://..." }, "restored": { "signed_url": "https://..." } } ``` If your Dataset is connected to Consumer App, it means that there are 2 Algorithm Application running on each image: 1. Application “FaceMetrics 2.0” will return one `webhook` when ALL metrics are calculated. 2. Application “Recommendation Engine” returns one `webhook` when products are matched. 3. If you select "Merge webhooks" in dataset settings, you will receive one `webhook` for with the results from all applications.
*** {% hint style="warning" %} Not a Haut.AI client yet? {% endhint %} Book a demo Platform overview on haut.ai --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.saas.haut.ai/haut.ai/haut.ai-features/consumer-apps/make-real-time-data-connection-with-external-platforms-via-webhooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.