Skip to content
Try for free
On this page

Integrations

TikTok

Access TikTok profiles and videos, and upload inbox drafts

Use TikTok to read the authenticated creator's profile and videos, send a video to their inbox as a draft, and track publishing status. The creator reviews and publishes drafts in TikTok; this integration does not publish them unattended. Webhooks can notify workflows about post and authorization changes.

OAuth scopes

Sim requests these scopes when someone connects a TikTok account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

SettingValue
Redirect URI<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/tiktok
Environment variablesTIKTOK_CLIENT_ID, TIKTOK_CLIENT_SECRET
ScopeDescription
user.info.basicRead a user's profile info (open id, avatar, display name)
user.info.profileRead a user's profile info (bio, verification status, username)
user.info.statsRead a user's stats (follower, following, likes, and video counts)
video.uploadShare content to a creator's account as a draft for further edit and post
video.listRead a user's public TikTok videos

Use the block

Get user profile information including follower counts and video statistics. List and query videos with cover images, embed links, and metadata. Send uploaded videos to the TikTok inbox as drafts for human review and publishing, then track post status.

Actions

TikTok Get User

Get the authenticated TikTok user profile information including display name, avatar, bio, follower count, and video statistics.

Input

ParameterTypeRequiredDescription
fieldsstringNoComma-separated allowlisted fields to return. open_id and display_name are always included. Available: open_id, union_id, avatar_url, avatar_large_url, display_name, bio_description, profile_deep_link, is_verified, username, follower_count, following_count, likes_count, video_count. Include avatar_url or avatar_large_url to receive avatarFile.

Output

ParameterTypeDescription
openIdstringUnique TikTok user ID for this application
unionIdstringUnique TikTok user ID across all apps from the same developer
displayNamestringUser display name
bioDescriptionstringUser bio description
profileDeepLinkstringDeep link to user TikTok profile
isVerifiedbooleanWhether the account is verified
usernamestringTikTok username
followerCountnumberNumber of followers
followingCountnumberNumber of accounts the user follows
likesCountnumberTotal likes received across all videos
videoCountnumberTotal number of public videos
avatarFilefileDownloadable copy of the profile avatar image (largest available variant), stored as a workflow file so it can be chained into file-consuming blocks (e.g. attached to an email).

TikTok List Videos

Get a list of the authenticated user's TikTok videos with cover images, titles, and metadata. Supports pagination.

Input

ParameterTypeRequiredDescription
maxCountnumberNoMaximum number of videos to return (1-20)
cursornumberNoCursor for pagination (from previous response)

Output

ParameterTypeDescription
videosarrayList of TikTok videos
↳ idstringVideo ID
↳ titlestringVideo title
↳ coverImageUrlstringSigned TikTok CDN cover URL. It is public but time-limited, so consume it immediately.
↳ embedLinkstringEmbeddable video URL
↳ embedHtmlstringHTML embed markup for the video
↳ durationnumberVideo duration in seconds
↳ createTimenumberUnix timestamp when the video was created
↳ shareUrlstringShareable video URL
↳ videoDescriptionstringVideo description or caption
↳ widthnumberVideo width in pixels
↳ heightnumberVideo height in pixels
↳ viewCountnumberNumber of views
↳ likeCountnumberNumber of likes
↳ commentCountnumberNumber of comments
↳ shareCountnumberNumber of shares
cursornumberCursor for fetching the next page of results
hasMorebooleanWhether there are more videos to fetch

TikTok Query Videos

Query specific TikTok videos by their IDs to get fresh metadata including cover images, embed links, and video details.

Input

ParameterTypeRequiredDescription
videoIdsarrayYesArray of video IDs to query (maximum 20)

Output

ParameterTypeDescription
videosarrayList of queried TikTok videos
↳ idstringVideo ID
↳ titlestringVideo title
↳ coverImageUrlstringSigned TikTok CDN cover URL. It is public but time-limited, so consume it immediately.
↳ embedLinkstringEmbeddable video URL
↳ embedHtmlstringHTML embed markup for the video
↳ durationnumberVideo duration in seconds
↳ createTimenumberUnix timestamp when the video was created
↳ shareUrlstringShareable video URL
↳ videoDescriptionstringVideo description or caption
↳ widthnumberVideo width in pixels
↳ heightnumberVideo height in pixels
↳ viewCountnumberNumber of views
↳ likeCountnumberNumber of likes
↳ commentCountnumberNumber of comments
↳ shareCountnumberNumber of shares

TikTok Upload Video Draft

Send an uploaded video to the authenticated user's TikTok inbox for manual editing and posting. The user must open TikTok and tap the inbox notification to complete the post. Rate limit: 6 requests per minute per user.

Input

ParameterTypeRequiredDescription
filefileYesVideo file to upload from the workflow. Maximum size: 250 MB.

Output

ParameterTypeDescription
publishIdstringUnique identifier for tracking the draft status. Use this with the Get Post Status tool to check when the user has completed posting from their inbox.

TikTok Get Post Status

Check the status of a video draft upload. Use the publishId returned from Upload Video Draft to track progress.

Input

ParameterTypeRequiredDescription
publishIdstringYesThe publish ID returned from a post/upload tool.

Output

ParameterTypeDescription
statusstringCurrent status of the post. Values: PROCESSING_UPLOAD/PROCESSING_DOWNLOAD (TikTok is processing the media), SEND_TO_USER_INBOX (draft delivered, awaiting user action), PUBLISH_COMPLETE (successfully posted), FAILED (check failReason).
failReasonstringReason for failure if status is FAILED. Null otherwise.
publiclyAvailablePostIdarrayArray of public post IDs (as strings) once the content is published and publicly viewable. Can be used to construct the TikTok post URL.
uploadedBytesnumberNumber of bytes uploaded to TikTok for FILE_UPLOAD posts
downloadedBytesnumberNumber of bytes TikTok reports as downloaded

Triggers

A trigger starts a workflow when a supported event occurs in this service.

TikTok Authorization Removed

Trigger when a user deauthorizes your TikTok app

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesTikTok Account

Output

ParameterTypeDescription
eventstringTikTok webhook event name
createTimenumberUTC epoch seconds when the event occurred
userOpenIdstringTikTok user open_id for the connected account
clientKeystringTikTok app client_key that received the event
reasonnumberRevocation reason (0 unknown, 1 user disconnect, 2 account deleted, 3 age change, 4 banned, 5 developer revoke)

TikTok Post Inbox Delivered

Trigger when a draft notification is delivered to the creator inbox

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesTikTok Account

Output

ParameterTypeDescription
eventstringTikTok webhook event name
createTimenumberUTC epoch seconds when the event occurred
userOpenIdstringTikTok user open_id for the connected account
clientKeystringTikTok app client_key that received the event
publishIdstringContent Posting API publish_id
publishTypestringPublish type (e.g. DIRECT_POST, INBOX_SHARE)

TikTok Post No Longer Public

Trigger when a post is no longer publicly viewable on TikTok

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesTikTok Account

Output

ParameterTypeDescription
eventstringTikTok webhook event name
createTimenumberUTC epoch seconds when the event occurred
userOpenIdstringTikTok user open_id for the connected account
clientKeystringTikTok app client_key that received the event
publishIdstringContent Posting API publish_id
publishTypestringPublish type (e.g. DIRECT_POST, INBOX_SHARE)
postIdstringTikTok post_id when the post is publicly available

TikTok Post Publicly Available

Trigger when a published post becomes publicly viewable on TikTok

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesTikTok Account

Output

ParameterTypeDescription
eventstringTikTok webhook event name
createTimenumberUTC epoch seconds when the event occurred
userOpenIdstringTikTok user open_id for the connected account
clientKeystringTikTok app client_key that received the event
publishIdstringContent Posting API publish_id
publishTypestringPublish type (e.g. DIRECT_POST, INBOX_SHARE)
postIdstringTikTok post_id when the post is publicly available

TikTok Post Publish Complete

Trigger when a TikTok Content Posting publish completes

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesTikTok Account

Output

ParameterTypeDescription
eventstringTikTok webhook event name
createTimenumberUTC epoch seconds when the event occurred
userOpenIdstringTikTok user open_id for the connected account
clientKeystringTikTok app client_key that received the event
publishIdstringContent Posting API publish_id
publishTypestringPublish type (e.g. DIRECT_POST, INBOX_SHARE)

TikTok Post Publish Failed

Trigger when a TikTok Content Posting publish fails

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesTikTok Account

Output

ParameterTypeDescription
eventstringTikTok webhook event name
createTimenumberUTC epoch seconds when the event occurred
userOpenIdstringTikTok user open_id for the connected account
clientKeystringTikTok app client_key that received the event
publishIdstringContent Posting API publish_id
publishTypestringPublish type (e.g. DIRECT_POST, INBOX_SHARE)
failReasonstringFailure reason enum from TikTok when publishing fails
Was this helpful?
Suggest an edit