Stape
Search
Try for free

TikTok Events API Gateway: the simplest way to set up TikTok Events API

Updated
Nov 13, 2024
Published
Oct 30, 2024

TikTok Events API Gateway is the newest and the simplest solution for implementing the TikTok Events API. You can skip the complexities of configuring event deduplication and avoid spending excessive time on tagging. It allows you to send user parameters and events directly from the server, while also supporting multiple Pixels in a single instance, even across different Business Manager accounts.

In this blog post, we’ll explore what the TikTok Events API Gateway offers and guide you through setting it up with Stape.

Overview of TikTok Events API Gateway

TikTok Events API Gateway has its own hub (aka environment). It operates on a cloud server, handling all interactions between the TikTok Pixel and the Conversions API.

Once the TikTok Pixel is connected to the API Gateway environment, it leverages web events to transmit data directly from the server. To maximize tracking accuracy, it's essential to ensure that web events include all necessary user and product details before implementing the TikTok Events API Gateway.

Pricing:

You can try TikTok Events API Gateway for free for 7 days without providing any billing details.

There are two plans: 

  • Pay as you go. $10 per month per Pixel.
  • Ultimate. $100 per month for 100 Pixels.

What is the difference between TikTok Events API Gateway and setting up TikTok CAPI tag through server GTM?

TikTok Events API Gateway provides an easy, quick setup designed specifically for TikTok event tracking with minimal effort. On the other hand, setting up TikTok Events API through server GTM offers greater flexibility and customization but requires more technical configuration and ongoing management.

TikTok Events API Gateway benefits

1. Low price.

TikTok Events API Gateway from Stape offers the most cost-effective solution for setting up and hosting TikTok Events API. You can start with a free plan, and then continue for just $10 per month per pixel!

2. Easy setup.

No need for developers or tracking experts — setting up the TikTok Events API Gateway is far more straightforward than traditional Events API implementations.

3. Zero maintenance required.

Automatic updates mean you won’t have to worry about manual adjustments or server configurations. When adding new events, simply configure web tracking, and the Events API Gateway will automatically handle server-side tracking.

How to set up TikTok Events API Gateway

Before you begin, ensure that TikTok web tracking is already configured on your site, whether it's implemented through a GTM container, embedded directly in the website code, or integrated via a plugin. This setup allows you to use existing web events.

1. Create a TikTok Events API Gateway on Stape.

1.1. Create an account or log in to Stape. Click on “Create Gateway” in the TikTok section.

Create a TikTok Events API Gateway on Stape

1.2. Write in the gaps:

  • Gateway name. You can create a random name.  
  • Admin email. This email will be used to manage your TikTok Events API Gateway and can be different from your Stape account email. It should be unique for each Gateway.
  • Server location. Select a location closer to your website visitors. 

Click “Create TikTok Events API Gateway”.

Create a TikTok Events API Gateway on Stape

1.3. Choose a subscription plan. Stape offers:

  • 7-day free trial.
  • Pay as you go plan - 10$/month per Pixel.
  • Ultimate plan - 100$/month for 100 Pixels.
Create a TikTok Events API Gateway on Stape

1.4. Wait till the status of your gateway is “Running”.

Create a TikTok Events API Gateway on Stape

2. Connect your Pixel.

2.1. Click on “Finish TikTok Gateway setup”. You will be redirected to the login interface of TikTok Gateway.

Connect your Pixel
Connect your Pixel

2.2. In the Events API Gateway hub click on “View details” and then - “Connect Data Source”.

Connect your Pixel
Connect your Pixel

2.3. Choose the account and Pixels you’d like to connect and confirm your choices.

Connect your Pixel

2.4. You will see the added pixel in your dashboard.

Connect your Pixel

Using a custom domain in your TikTok Events API Gateway can improve measurement performance. It allows you to choose the subdomain for the Pixel's communication with the Events API Gateway. This custom domain should match the subdomain used for firing the TikTok Pixel.

3.1. Click “Settings” on the menu. Push the button “Set up domain”.

[Recommended] Add custom domain.

3.2. Choose domain and receive DNS records to configure.

[Recommended] Add custom domain.
[Recommended] Add custom domain.

3.3. Log in to your DNS provider and set records (if you use Cloudflare, the settings should look like on the screenshot). 

[Recommended] Add custom domain.

3.4. And that’s it! You’ve successfully set up your subdomain.

This will help you increase the protection of your events from ad blockers.

After validating your Data routing domain you will see a link that you can use to download TikTok js on your site. Click on “View base code” and copy the snippet.

[Recommended] Load TikTok js from your subdomain.
[Recommended] Load TikTok js from your subdomain.

5. [Optional] Add new Pixels.

You can use a single TikTok Events API Gateway to set up multiple TikTok Pixels. Additionally, Pixels from various TikTok Business Accounts can be connected to the same Events API Gateway, provided you have admin access to all the Pixels. 

The process is straightforward: configure your TikTok Events API Gateway, then add new Pixels through the hub interface. Simply click on “Connect data source”.

[Optional] Add new Pixels.

6. Test your setup.

As mentioned before, TikTok Events Gateway uses web events to route them via the server. 

6.1. Within 30 minutes of connecting your pixel to the TikTok eAPI Gateway hub, you should notice that the event count is no longer zero, and you should also see the names of the events that have been received. 

Test your setup

6.2. You can also verify that events are sent correctly to the TikTok Events APIG hub by checking the website console:

  1. Open your browser developer network tab on your site.
  2. Check that events were sent to your Events API Gateway URL (look at the screenshot below).
Test your setup

Conclusion

TikTok Events API Gateway makes server-side tracking for TikTok easy and quick. No more complicated setups or high costs. You can get it running even without technical skills. 

But if you’d like to try the server GTM implementation of TikTok Events API - please be free to read our detailed guide.

Try Stape for all things server-sideright now!