Payload Definition
The payload definitions for each event listed in the Bridge Guide are as follows.
sauceShowroomMoveBanner
Passes the predefined values when a banner is clicked.
Property | Type | Description |
|---|---|---|
bannerId | String | BannerId |
linkTypeCode | 'URL' | 'APP_SCHEME' | 'NONE' | linkType |
linkUrl | String | URL linked to the banner |
linkUrlTargetTypeCode | 'SELF' | 'BLANK' | null | How the link opens |
partnerUniqueId | String | Partner ID |
sauceShowroomMoveProduct
Passes the predefined values when a product is clicked.
| Property | Type | Description |
|---|---|---|
| linkUrl | String | URL linked to the product |
| partnerUniqueId | String | Partner ID |
| productUniqueId | String | Product ID |
sauceShowroomMoveSauceClipPlayer
Passes the required values when navigating to the clip player.
| Property | Type | Description |
|---|---|---|
| clipCurationId | String | Curation ID of the clip |
| clipId | String | Clip ID |
| clipUrl | String | Clip player URL |
| partnerUniqueId | String | Partner ID |
sauceShowroomMoveSauceLivePlayer
Passes the required values when navigating to the live player.
Property | Type | Description |
|---|---|---|
broadcastId | String | LIVE/VOD ID |
broadcastUrl | String | Live player URL |
partnerUniqueId | String | Partner ID |
vodCurationId | String | undefined | Curation ID of the linked VOD |
sauceShowroomTurnOnNotification
Passes the relevant values when clicking to receive a live notification.
| Property | Type | Description |
|---|---|---|
| broadcastId | String | LIVE ID |
| broadcastUrl | String | Live player URL |
| memberId | String | User identifier ID |
| partnerUniqueId | String | Partner ID |
| programmingStartDt | String | Scheduled start time of the live, format: YYYY-MM-DD hh:mm:ss (UTC) |
| programmingEndDt | String | Scheduled end time of the live, format: YYYY-MM-DD hh:mm:ss (UTC) |
sauceShowroomTurnOffNotification
Passes the relevant values when clicking to cancel a live notification.
| Property | Type | Description |
|---|---|---|
| broadcastId | String | LIVE ID |
| broadcastUrl | String | Live player URL |
| memberId | String | User identifier ID |
| partnerUniqueId | String | Partner ID |
| programmingStartDt | String | Scheduled start time of the live, format: YYYY-MM-DD hh:mm:ss (UTC) |
| programmingEndDt | String | Scheduled end time of the live, format: YYYY-MM-DD hh:mm:ss (UTC) |
sauceShowroomMemberLogin
Requests the event without a payload.
| Property | Type | Description |
|---|---|---|
| - | - | - |
sauceShowroomTurnOnNotificationCallback
Passes the predefined value upon successful notification registration.
| Property | Type | Description |
|---|---|---|
| broadcastId | String | LIVE ID |
sauceShowroomTurnOffNotificationCallback
Passes the predefined value upon successful notification cancellation.
| Property | Type | Description |
|---|---|---|
| broadcastId | String | LIVE ID |
Updated about 1 month ago