> ## Documentation Index
> Fetch the complete documentation index at: https://partner-integrations.voyado.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tik Tok Leads - BETA

<Warning>
  This feature is currently in BETA and Voyado is actively seeking user feedback to improve its performance and function. As a beta feature, it may undergo frequent updates and enhancements. Check for updates regularly to take advantage of the latest improvements. While beta features have been rigorously tested, they could contain issues, bugs, or glitches. Be prepared for occasional disruptions, and report any issues you find.
</Warning>

To gain access to TikTok leads, Engage users should contact their Voyado account manager.

## Configuring TikTok Leads

Follow the step to complete the configuration.

<Steps>
  <Step title="Create contact attribute">
    To track what form the customer has arrived from, you'll need to first go to **Config Hub** and create a custom attribute called `customSource` of type "string".

    <Card title="Learn about Config Hub" href="https://help.engage.voyado.com/hc/en-gb/sections/21844508239004-Configuring-Engage-via-Config-Hub" icon="https://mintcdn.com/voyado-partners/0IxEIB2Y6a--gNYY/icons/help-center-link.png?fit=max&auto=format&n=0IxEIB2Y6a--gNYY&q=85&s=4e7f518f776580d7cdae461a964ea2dc" horizontal width="128" height="128" data-path="icons/help-center-link.png" />

    Do it like this:

    <Frame>
      <img src="https://mintcdn.com/voyado-partners/8vQwsCBDrVqN4eeP/images/tik-tok-leads/tik-tok-leads-01.png?fit=max&auto=format&n=8vQwsCBDrVqN4eeP&q=85&s=d20daed0ccf04405c9f15a0c8c1c39db" alt="Creating custom contact attribute" width="944" height="940" data-path="images/tik-tok-leads/tik-tok-leads-01.png" />
    </Frame>

    <Tip>
      The same custom contact attribute is used for TikTok and Meta, so if this has already been set up for Meta, skip this step.
    </Tip>
  </Step>

  <Step title="Initial setup">
    Now log into Onsite Manager:

    <Card title="Take me to Onsite Manager" icon="right" horizontal href="https://manager.onsite.voyado.com/login" />

    Or go to **Config Hub** again where you can configure Lead Ads.

    <Frame>
      <img src="https://mintcdn.com/voyado-partners/8vQwsCBDrVqN4eeP/images/tik-tok-leads/tik-tok-leads-02.png?fit=max&auto=format&n=8vQwsCBDrVqN4eeP&q=85&s=751ac4860c00e6c3d8819f03258644ab" alt="Configuring Lead Ads" width="720" height="420" data-path="images/tik-tok-leads/tik-tok-leads-02.png" />
    </Frame>

    If you don't see Lead Ads in Config Hub, contact Voyado's support:

    <Card title="Contact Voyado Support" icon="envelope" horizontal href="mailto:support@voyado.com)" />
  </Step>

  <Step title="Accelerator Setup">
    In Onsite Manager go to: **Accelerator Configuration → Accelerators for lead ads**

    If this section is missing, contact Voyado's support;

    <Card title="Contact Voyado Support" icon="envelope" horizontal href="mailto:support@voyado.com)" />

    Use your existing site in OSM. Currently, you can only connect to **one** site in OSM.
  </Step>

  <Step title="Connect to TikTok">
    In Onsite Manager press **Actions → Edit**.

    In the **TikTok** section, connect to your TikTok Page.

    Select **Connect** then add the account you want to connect to:

    <Frame>
      <img src="https://mintcdn.com/voyado-partners/8vQwsCBDrVqN4eeP/images/tik-tok-leads/tik-tok-leads-03.png?fit=max&auto=format&n=8vQwsCBDrVqN4eeP&q=85&s=505289dde794ea312d563b25de08d03a" alt="Configuring Lead Ads" width="592" height="740" data-path="images/tik-tok-leads/tik-tok-leads-03.png" />
    </Frame>

    Press **Confirm** and you should be authenticated to TikTok.
  </Step>

  <Step title="Form mapping">
    Once connected, Engage will pull in your TikTok Lead Forms.

    If no forms are visible, ensure one has been created for your campaign.

    Choose the form you want and then map its fields to Engage.

    The **Get forms** button will fetch all the forms on your page that you can connect to Voyado Engage.

    Once you've done that, you will get a list of forms under **TikTok forms**.

    Press on the form that you want to connect to Engage and then press the button **Get fields**. This will retrive all the fields on that specific form.

    Do the mapping of fields as shown in the image and then press **Save**.

    <Frame>
      <img src="https://mintcdn.com/voyado-partners/8vQwsCBDrVqN4eeP/images/tik-tok-leads/tik-tok-leads-04.png?fit=max&auto=format&n=8vQwsCBDrVqN4eeP&q=85&s=584fc89077c5c3fdbee81d675ae7965e" alt="Configuring Lead Ads" width="902" height="1548" data-path="images/tik-tok-leads/tik-tok-leads-04.png" />
    </Frame>
  </Step>
</Steps>

## Testing

After setting up your TikTok Lead Ads integration in Engage, you'll want to check that your setup works as expected. You can use TikTok's built-in Lead Ads Testing Tool to create test submissions that simulate a real lead. This is especially useful before running a live campaign.

Before you begin, make sure that:

* Your TikTok Page and Lead Form are already created
* The TikTok Lead Ads integration is active in Engage
* You've selected the correct Page and Form in the integration setup
* Your TikTok user has the right permissions

Then follow this procedure:

### 1. Open the testing tool

Visit TikTok's Lead Ads Testing Tool, here:

<Card title="Show me TikTok's testing tool" href="https://ads.tiktok.com/lead_center/forms" icon="https://mintcdn.com/voyado-partners/0IxEIB2Y6a--gNYY/icons/help-center-link.png?fit=max&auto=format&n=0IxEIB2Y6a--gNYY&q=85&s=4e7f518f776580d7cdae461a964ea2dc" horizontal width="128" height="128" data-path="icons/help-center-link.png" />

### 2. Select your TikTok Lead Form

From the dropdowns:

* Choose the TikTok account running your lead ad
* Select the form you want to test

### 3. Create a test lead

Select **Create Lead** to simulate a new lead submission.

<Tip>
  This lead will not appear in your Ads Manager or Page Inbox, only through the API integration.
</Tip>

### 4. Verify the lead in Engage

Once created, go back to Voyado Engage to verify the lead exists. You can do this in two ways:

* Searching directly for the contact in Engage
* Or looking for them via segmentations using either:
  * customSource: \[\[name of form]]
  * source: TikTok

### 5. Troubleshooting

If the lead doesn't appear:

* Ensure your TikTok user has Leads Access to the account
* Recheck that the correct TikTok account and Form are selected in Engage
* Check if the lead was already created; duplicate test submissions might be ignored if your form doesn't allow them

To remove test data, delete the test contact directly in Engage after verification.
