Webhook Events

Webhooks let you subscribe to events and receive notice when an event occurs. For more information about how to set up a webhook subscription, see Webhooks Overview.

By default, you are subscribed to all events when a callback URL is configured in the TikTok Developer Portal.

Webhook Structure

Request Body

Event types

authorization.removed

Fired when the user's account deauthorized from your application.

The access_token for the user will have been already revoked when you receive the disconnect callback message. Developers can persist this information for clean-up purposes.

Example payload

{
    "client_key": "bwo2m45353a6k85",
    "event": "authorization.removed",
    "create_time": 1615338610,
    "user_openid": "act.example12345Example12345Example",
    "content": "{\"reason\": 1 }"
}

video.upload.failed

Fired when the video uploaded from Video Kit fails to upload in TikTok.

Example payload

{
    "client_key": "bwo2m45353a6k85",
    "event": "video.upload.failed",
    "create_time": 1615338610,
    "user_openid": "act.example12345Example12345Example",
    "content":"{\"share_id\":\"video.6974245311675353080.VDCxrcMJ\"}"
}

video.publish.completed

Fired when the video uploaded from Video Kit has been published by the user in TikTok.

Example payload

{
    "client_key": "bwo2m45353a6k85",
    "event": "video.publish.completed",
    "create_time": 1615338610,
    "user_openid": "act.example12345Example12345Example",
    "content":"{\"share_id\":\"video.6974245311675353080.VDCxrcMJ\"}"
}

portability.download.ready

Fired when data requested via from the Data Portability API is in the downloading state.

Example payload:

{
    "client_key": "developer_client_key",
    "event": "portability.download.ready",
    "create_time": 1615338610,
    "content":"{\"request_id\":123123123123123}"
}

Note: content is a JSON object marshalled as a string

{
    "request_id": 123123123123123
}

Payload content