> For the complete documentation index, see [llms.txt](https://docs.omnichat.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omnichat.ai/en/features/she-ding/third-party-survey.md).

# SurveyCake Integration Set Up

This section outlines the steps to integrate SurveyCake with Omnichat, which allows you to automate survey distribution with the Chatbot Module through your connected messaging channels (Facebook Messenger, LINE, Instagram, and WhatsApp). This approach efficiently gathers valuable feedback from your contacts and lets you import the data as tags or custom attributes for improved contact organization and segmentation.

Currently in Phase 1, this setup only allows the manual export of SurveyCake survey data. You will import the data into Omnichat to update your contact tags and custom attributes.

## Setting Up on SurveyCake

First, create a survey on your SurveyCake account.

{% hint style="warning" %}
Ensure that you are on a **Pro Plan** to be able to connect your SurveyCake account with Omnichat.
{% endhint %}

1. Log in to the SurveyCake admin portal and enter the survey editor for your created survey.
   * Add two "Single Line Text" questions at the very top of the survey to collect the "Channel ID" and "User ID" respectively.
   * Click open the question toolbar, then select "Advanced" > "Identifier and Default Value".

{% hint style="info" %}
To prevent respondents from altering the data, you can set these questions to "Hide".
{% endhint %}

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2F42ENtsayYies4w2lVqFD%2Fimage.png?alt=media&amp;token=6060461c-49f3-41f7-a119-92d794acda2e" alt=""><figcaption></figcaption></figure>

2. Once there, add the question identifier for your question.&#x20;

* Click [here](https://en-docs.omnichat.ai/features/tong-xun-qu-dao/third-party-survey/configuring-question-identifiers) to learn more on how to configure your identifier.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FST3QbOHO35ggxIvfjbrJ%2Fimage.png?alt=media&amp;token=e9a2f9b8-e1ea-419c-9199-327fb743b1ec" alt=""><figcaption></figcaption></figure>

3. channel\_user\_id: We also recommend checking the 'Unrepeatable' option, so SurveyCake can validate duplicate UIDs. This helps prevent issues with survey links being publicly shared or reused.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2F1k20ninduWL56zdcBRS2%2Fimage.png?alt=media&amp;token=93046f2c-a617-4a0a-a664-b46ff2639e3c" alt=""><figcaption></figcaption></figure>

4. To prevent respondents from altering the data, you can set these questions to "Hide".

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FHAGKpV5vAKnJb5vnBTdo%2Fimage.png?alt=media&amp;token=d4e29cd9-ee52-4f67-b25b-b6b71d11f347" alt=""><figcaption></figcaption></figure>

5. Once you are done with your survey questions, proceed to Omnichat's Chatbot Module after saving your survey setup.

## Setting Up on Omnichat

#### Step 1: Log in to your Omnichat portal.

1. Navigate to the "Settings" page.
2. Under "Integrations", click on "SurveyCake" to proceed.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FIIvNkkMqZS0uWxKMfaT0%2Fimage.png?alt=media&amp;token=aeaf2d2f-dd7e-4284-afa7-6b47c6752dd8" alt=""><figcaption></figcaption></figure>

#### Step 2: Integrate Omnichat with SurveyCake

To integrate Omnichat with SurveyCake, please complete the following fields on the Omnichat SurveyCake integration page:

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2F1QlRoUeqnnNbgBYY4r3E%2Fsurvaycake%20eng.jpg?alt=media&amp;token=24645ece-a90c-4627-8595-0f858dba961c" alt="" width="563"><figcaption></figcaption></figure>

1. **Name**
2. **Survey Link**
3. **Hash Key**
4. **IV Key**
5. **Response Settings**（Once enabling it, can save survey completion time as a custom attribute）

#### Step 3: How to get **SurveyCake URL**

Go to the SurveyCake portal, click the “...” icon in the bottom-right corner of your survey, select ”Survey Link“, and copy the URL.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FILnK6Cv8p88If5Ix87uw%2Fimage.png?alt=media&amp;token=f8aeac9a-0ef5-4eef-8f96-8ef9b90c0d58" alt="" width="563"><figcaption></figcaption></figure>

Return to the Omnichat portal and paste the survey URL. The ”Survey Sending Link“ section will automatically generate a dedicated link with parameters attached.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FSw1Wnp8pkq2KrkIWYWQl%2Fimage.png?alt=media&amp;token=6ba1323a-81fa-430f-af9a-72a4a8792a94" alt="" width="563"><figcaption></figcaption></figure>

#### Step 4: How to get **SurveyCake Hash Key and IV Key**

Go to the SurveyCake portal, click the '...' icon in the bottom-right corner of your survey, and select “Notification”.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2F96dp9uXleoUNUbtT3wsB%2Fimage.png?alt=media&amp;token=3855ac5b-2ec3-4c9e-8d09-80d0b5d7cef2" alt=""><figcaption></figcaption></figure>

Go to the Notifications page, click the Webhook tab, copy the Hash Key & IV Key, and paste them back into the SurveyCake page on the Omnichat portal.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2Fu9aKzARzWSRMXxe8bgaK%2Fimage.png?alt=media&amp;token=8d5ae49b-4e21-40aa-a1a2-e568b6a195c0" alt=""><figcaption></figcaption></figure>

#### Step 5: Paste Omnichat Webhook URL into SurveyCake portal

Return to the Omnichat portal, copy the Omnichat Webhook URL, and paste it into the Webhook field on the SurveyCake portal.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FTk7b4kmZKV5A9S3i5PbG%2Fimage.png?alt=media&amp;token=c82fb840-4d3b-471b-b6b2-655243b7b37a" alt="" width="563"><figcaption></figcaption></figure>

Navigate to the Webhook page in the SurveyCake portal, paste the Omnichat Webhook URL, and click Save.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FCYBKFE83pdaPDSWc1h3p%2Fimage.png?alt=media&amp;token=0307904c-c499-4f00-8d7e-a49c09903885" alt=""><figcaption></figcaption></figure>

#### Step 6 Insert the survey sending link previously generated by Omnichat into the message flow card button.

1. Go to the SurveyCake page in Omnichat and copy the Survey Sending Link.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FaM8CPOAmMlxkyOdnqK3k%2Fimage.png?alt=media&amp;token=53fd1b87-c8c0-4d00-abcf-6dd26abb88a3" alt="" width="563"><figcaption></figcaption></figure>

2. Go to the Message Flow editor page and add a new chatbot card with a button.
3. Under Open URL, paste the Survey Sending Link you copied earlier.

{% hint style="warning" %} <mark style="color:red;">**Please do not modify the survey URL parameters, as changes may prevent data from automatically populating into the survey.**</mark>
{% endhint %}

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2F00suFuyEaJg0HrUxmtLp%2Fimage.png?alt=media&amp;token=9cca36b6-3cf1-46bf-8609-e5640f2c3bb0" alt=""><figcaption></figcaption></figure>

Once the chatbot card setup is complete, you can start sharing it with your customers across various scenarios to collect survey responses!

When a customer fills out the survey via the dedicated link inside the chatbot card, the system will automatically populate their Channel Name and User ID into the survey.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FUoFeW5z3e1F8xy0nUca8%2F%E6%88%AA%E5%9C%96%202026-09-11%20%E4%B8%8B%E5%8D%886.08.10.png?alt=media&amp;token=5b046fd1-d24a-4585-859a-810be38d0186" alt="" width="563"><figcaption></figcaption></figure>

Once a customer submits the survey, their response tags will automatically sync back to their contact profile in Omnichat.

Meanwhile, you can view the passed variables alongside the survey responses on the Detail Export page in SurveyCake.

You can also export the responses as a CSV file for manual data processing, and then import them back into the Omnichat portal.

## Survey Details & Data Import

1. In your SurveyCake account, click on your survey and go to Data Report. This is where you will see all your collected data.<br>

   ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-07-06/7d320f85-eeb1-4163-84aa-ddadfb01c53f/user_cropped_screenshot.jpeg?tl_px=0,0\&br_px=1719,961\&force_format=png\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=262,86)
2. Click the "**Export as**" dropdown and select "**CSV Format**" to download your report.<br>

   ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2024-07-06/323210a3-33b2-4807-b406-86147e08b3f2/user_cropped_screenshot.jpeg?tl_px=429,3\&br_px=2149,964\&force_format=png\&width=1120.0\&wat=1\&wat_opacity=0.7\&wat_gravity=northwest\&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png\&wat_pad=985,277)
3. Once you have downloaded the report, you will have manually reorganize the downloaded CSV file to match Omnichat's contact import template. You can find this template by navigating to **Social CDP > Data Import** in Omnichat.<br>

   <figure><img src="https://lh7-us.googleusercontent.com/slidesz/AGV_vUeYjb3i7UdNiiFIMH47HTNBQmR5bXC8XD7jaB92GKVqLacVvPCODE9qrEJI6Q5Py9ObzAlVjv2AoTx4UAxA9Vl2sL0wC83uV0qTZcNog9xE2GsoA0BiP_jdSBUoJquK8IlYeUK1O6JC3beH7rzfbN4Qf7F7j2pJ=s2048?key=7A5QaWk6rZVocbpwLRS25w" alt="" width="563"><figcaption></figcaption></figure>
4. Proceed to organize your survey responses as tags or custom attributes within the file. This allows for further segmentation and analysis within Omnichat.
5. Navigate back to the **Social CDP > Data Import** section. Upload the prepared CSV file containing your organized survey data.

{% hint style="info" %}
**Enhancements Planned**: In Phase 2, we will introduce automatic tag import functionality for surveys. However, custom attributes will still require manual processing for the time being.
{% endhint %}
