(63) Activity change

POST

The Activity change webhook is designed to notify partners about modifications related to activities and the products associated with them. This allows applications to stay synchronized with changes in activity details or product inclusion/exclusion lists.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

shop_id

The ID of the shop.

string

timestamp

The time when this webhook was triggered, represented by Unix timestamp.

integer format: int64

tts_notification_id

The ID of the notification.

string

type

required

The ID of the webhook type.

integer

Allowed value: 63

data

object

activity_id

The ID of the promotion activity.

string

update_time

The time when the status changed, represented as a Unix timestamp (seconds).

integer format: int64

change_type

The type of activity changes.

• CREATE
• UPDATE
• DEACTIVATE

string

product_update_list

Products included in an updated scope.

object

product_ids

Included product IDs.

Array<string>

exclude_product_ids

IDs of the BXGY exclude products to remove. Max count: 100.

Array<string>

<= 100 items

benefit_product_ids

TikTokShop product ID list.

Array<string>

product_remove_list

Products removed from the activity.

object

product_ids

Removed product IDs.

Array<string>

sku_ids

Removed SKU IDs.

Array<string>

benefit_product_ids

TikTokShop product ID list.

Array<string>

exclude_product_ids

IDs of the BXGY exclude products to remove. Max count: 100.

Array<string>

<= 100 items

Example

{
  "type": 63,
  "timestamp": 1678886400,
  "shop_id": "789123456789123456",
  "tts_notification_id": "000000000000000001",
  "data": {
    "activity_id": "act_123456789012345678",
    "update_time": 1678886400,
    "change_type": "product_update",
    "product_update_list": {
      "product_ids": [
        "11111111",
        "22222222"
      ],
      "exclude_product_ids": [
        "33333333"
      ],
      "benefit_product_ids": [
        "44444444"
      ]
    },
    "product_remove_list": {
      "product_ids": [
        "55555555"
      ],
      "sku_ids": [
        "66666666"
      ],
      "benefit_product_ids": [],
      "exclude_product_ids": []
    }
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.