TikTok Lead Generation
Read Instant Form and direct-message leads from TikTok's Business API — the Lead Generation surface of the Marketing API.
About
TikTok Lead Generation ships in the w6w first-party pack. It declares 4 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.
- App id
io.w6w.tiktok-lead-generation- Version
- 0.1.0
- Author
- w6w
- Licence
- MIT
- Categories
- Marketing · Social Media
Overview
TikTok Lead Generation reads the leads collected through TikTok’s Instant Form ads and direct-message lead ads, via the Lead Generation surface of TikTok’s Business (Marketing) API — distinct from the general TikTok Ads/Marketing API surface (campaign, ad group and ad management), which this app deliberately does not cover.
The app exposes only what could be independently confirmed as real, live endpoints on business-api.tiktok.com: fetching a single Instant Form or direct-message lead, reading the field schema of a form, fetching a lead captured through an organic TikTok Page, and bulk-downloading a Page’s leads. TikTok’s own documentation portal renders every endpoint page client-side from an internal, non-public API, so the exact request/response field names beyond the universal advertiser_id / filtering / page / page_size convention used across the whole Marketing API could not be fetched — see the README for exactly what was verified, how, and what was deliberately left out rather than guessed.
Build with TikTok Lead Generation
Three routes to the same 4 actions. The Workflow tab is generated from TikTok Lead Generation's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.
Download Page Leads
download-page-leads Bulk-fetch the leads captured through a TikTok (organic) Business Page's Instant Forms. `businessId` is this app's best-supported guess at the required scope id for this route (see the app README); use `filtering` for anything TikTok names differently for your account, such as a date range or a specific form.
Get Lead
get-lead Fetch an Instant Form or direct-message lead captured through TikTok ads. `filtering` is passed through verbatim as TikTok's raw JSON filter object for this endpoint (e.g. a form or lead id) — TikTok's own field names for it could not be independently confirmed; see the app README.
Get Lead Form Fields
get-lead-fields Fetch the field schema of an Instant Form or direct-message lead ad. `filtering` is passed through verbatim as TikTok's raw JSON filter object (e.g. the form id) — see the app README for why the exact field name isn't hardcoded here.
Get Page Lead
get-page-lead Fetch a lead captured through a TikTok (organic) Business Page's Instant Form, as opposed to a paid ad. `businessId` is this app's best-supported guess at the required scope id for this route (see the app README); use `filtering` to pass any field TikTok actually names differently for your account.
A workflow step names the app and the action, and the editor fills in the
connection when you pick one. This is the Step shape from the
workflow spec, carrying TikTok Lead Generation's real ids.
{
"manifestVersion": "2",
"name": "tiktok-lead-generation-example",
"steps": [
{
"id": "download-page-leads",
"uses": {
"app": "io.w6w.tiktok-lead-generation",
"action": "download-page-leads",
"connection": "conn_YOUR_CONNECTION_ID"
},
"with": {
"businessId": "<businessId>"
}
}
]
}Here are some of the things you can do
-
Download Page Leads
readdownload-page-leads -
Get Lead
readget-lead -
Get Lead Form Fields
readget-lead-fields -
Get Page Lead
readget-page-lead
Every app-specific value here is a blank you have to fill in. An
app action is reached through the connection that authenticates it, so the
address is a connection id, not the app id — and connections belong to your account,
so a public page cannot know yours. Create one for TikTok Lead Generation, then fill in
the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the
parameters that action declares. The call itself is real — the shape is transcribed
from the studio's own snippet builder, which prints the same kind of blanks — but
nothing in it is specific to TikTok Lead Generation. The Workflow tab is where this app's
real ids are.
npm install @w6w/sdkyarn add @w6w/sdkpnpm add @w6w/sdkdeno add npm:@w6w/sdkimport { W6wClient, isActionRun } from "@w6w/sdk";
// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();
const envelope = await client.run({
urn: "conn_YOUR_CONNECTION_ID",
action: "download-page-leads",
payload: {
businessId: "<value>",
// filtering: "<value>",
},
});
if (isActionRun(envelope)) console.log(envelope.value);npm install -g @w6w/cliw6w run conn_YOUR_CONNECTION_ID --action download-page-leads --payload '{"businessId":"<value>"}'Give an AI agent TikTok Lead Generation — without giving it TikTok Lead Generation's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.
One tool call{
"name": "w6w_invoke",
"arguments": {
"ref": "app:io.w6w.tiktok-lead-generation#download-page-leads",
"input": {
"businessId": "<businessId>"
}
}
}
Every tool names its target with a single ref. The
app: form above doesn't name a connection at all — the
host resolves which of the caller's TikTok Lead Generation connections to sign
with, and refuses rather than guesses when the answer is ambiguous.
What the agent gets
Credentials it can't read
The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.
A tool surface scoped to the caller
Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.
A durable workflow in one call
Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.
Health-aware discovery
TikTok Lead Generation's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.
The MCP surface is part of the hosted platform. TikTok Lead Generation itself is MIT, and the runtime that executes it is source-available (FSL).
Health checks
TikTok Lead Generation declares its own checks, so its health is a property of the app rather than something the host guesses at.