(17) Shoppable content posting

资料正文

§1 (17) Shoppable content posting

§2 Trigger scenario

Trigger scenario

The shoppable content posting webhook is triggered when the creator adds, updates, or removes a product link in a video or livestream.

This webhook will only be triggered after the creator has authorized the Read Creator Affiliate Collaborations scope.

§3 Data business parameters

Data business parameters

Parameter name	Data Type	Sample	Description
type	int	`17`	The ID of the webhook type.
tts_notification_id	string	`"7327112393057371910"`	The ID of the notification.
creator_open_id	string	`"VIyStQAAAADCBQ40s4TzOSSOEIW-bM5O9cod3vK8OytW8m-bnBYlXw"`	The open_id of the creator. To get the value, see Authorization overview.
timestamp	int	`1644412885`	The UNIX timestamp when this webhook was triggered.
data	object
└product_id	string	`"789078671231"`	ID of the product promoted in the creator's video.
└event	object
└└type	string	`"ADD"`	The action which the creator takes to the product promoted in the video or live stream. The possible enumerations are: * `ADD`: Add the product. * `UPDATE`: Update the product. * `REMOVE`: Remove the product.
└└scene	string	`"VIDEO"`	The scene where the creator promotes the product. The possible enumerations are: * `VIDEO`: short video.
└└content_id	string	`"789078671231"`	The ID of the short video.

§4 Event example

Event example

{
  "type": 17,
  "creator_open_id": "VIyStQAAAADCBQ40s4TzOSSOEIW-bM5O9cod3vK8OytW8m-bnBYlXw",
  "tts_notification_id" : "7327112393057371910",
  "timestamp": 1644412885,
  "data": {
    "product_id": "789078671231",
    "event": {
      "type": "ADD",
      "scene": "VIDEO",
      "content_id": "789078671231"
    }
  }
}