(17) Shoppable content posting

POST

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.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 17

tts_notification_id

The ID of the notification.

string

creator_open_id

The open_id of the creator. To get the value, see Authorization overview.

string

timestamp

The UNIX timestamp when this webhook was triggered.

integer format: int64

data

object

product_id

ID of the product promoted in the creator’s video.

string

event

object

type

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.

string

Allowed values: ADD UPDATE REMOVE

scene

The scene where the creator promotes the product. The possible enumerations are:

• VIDEO: short video.

string

Allowed values: VIDEO

content_id

The ID of the short video.

string

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"
    }
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.