Requirements
Using this requires either PostHog Cloud with the data pipelines add-on, or a self-hosted PostHog instance running a recent version of the Docker image.
You'll also need access to the relevant TikTok Ads account.
Installation
In PostHog, click the Data pipeline tab in the left sidebar.
Click the Destinations tab.
Search for TikTok Ads Conversions and select the destination.
Visit the TikTok Events Manager.
- If you’ve already set up a Pixel for your website, we recommend that you use the same Pixel for your browser and server events.
- To create a new Pixel, click Connect data source and select Web.
- Skip the Add your website step.
- For the connection method, select Manual setup and Events API.
- Enter a name for your Pixel and click Create.
- Go to your Pixel via Data sources.
- Switch to the Settings tab and your Pixel ID will be listed as ID.
- You can create an access token by clicking Generate Access Token.
- If you’ve already set up a Pixel for your website, we recommend that you use the same Pixel for your browser and server events.
Back in PostHog, add the Pixel ID and Access token to the destination configuration.
Set up your event and property filters to remove unnecessary events. You only want to send events that are conversions. Filter out unrelated events or ones missing required data.
Press Create & enable, test your destination, and then watch your conversions get sent to TikTok Ads.
Configuration
Option | Description |
---|---|
Access token Type: string Required: True | Check out this page on how to obtain such a token: https://business-api.tiktok.com/portal/docs?id=1771101027431425 |
Pixel ID Type: string Required: True | You must obtain a Pixel ID to use the Conversions API. If you've already set up a Pixel for your website, we recommend that you use the same Pixel ID for your browser and server events. |
Event name Type: string Required: True | A standard event or custom event name. |
Event ID Type: string Required: True | The ID of the event. |
Event timestamp Type: string Required: True | A Unix timestamp in seconds indicating when the actual event occurred. |
User properties Type: dictionary Required: True | A map that contains customer information data. See this page for options: https://business-api.tiktok.com/portal/docs?id=1771101151059969#item-link-user%20parameters |
Property properties Type: dictionary Required: True | A map that contains customer information data. See this page for options: https://business-api.tiktok.com/portal/docs?id=1771101151059969#item-link-properties%20parameters |
Page properties Type: dictionary Required: True | A map that contains page information data. See this page for options: https://business-api.tiktok.com/portal/docs?id=1771101151059969#item-link-page%20parameters |
Test Event Code Type: string Required: False | Use this field to specify that events should be test events rather than actual traffic. You'll want to remove your Test Event Code when sending real traffic through this integration. |
FAQ
Is the source code for this destination available?
PostHog is open-source and so are all the destination on the platform. The source code is available on GitHub.
Who maintains this?
This is maintained by PostHog. If you have issues with it not functioning as intended, please let us know!
What if I have feedback on this destination?
We love feature requests and feedback. Please tell us what you think.
What if my question isn't answered above?
We love answering questions. Ask us anything via our community forum.