Win Sharing

Overview

The "Big Win / Big X" widget is designed for integration into partner application chats, allowing users to share their large winnings (Big Win). The widget allows users to share their achievements themselves.

Technical requirements for widget formation

To create the "Big Win / Big X" widget, the following data must be provided:

• Game icon / image: URL to the image that will be displayed on the widget.
• Title: The name of the game or event, passed as a string.
• Text: Description of the type of win, for example, "Big Win" or "Big X".
• Text in pseudo-button: Winning status or odds in string format, for example, "won $12,000" or "x100500".
• Game link: URL that will open the game when the widget is clicked. Ideally, the partner should have a mechanism for recognizing the source of the game opening.
• Time stamp: The date and time when the event (winning) occurred, passed in the ISO 8601 format, for example, "2024-05-10T12:00:00Z".

When the user wants to share their win, the application will request via API data about the user's latest wins by their userId. The data should support pagination to manage the volume of information loaded.

It is backend to backend API, with unencrypted userid and have to protected with Bearer token from partner side.

API request for winnings data:

GET /api/user/wins?userid={id of user}&limit={limit}&offset={offset}

API response:

{
  "items": [
    {
      "id": "123123",
      "title": "Lucky Spin",
      "text": "Big Win",
      "iconUrl": "<https://example.com/icons/lucky-spin.png>",
      "buttonText": "won $5,000",
      "gameUrl": "<https://example.com/games/lucky-spin>",
      "timestamp": "2024-05-10T12:00:00Z"

    },
    {
      "id": "123124",
      "title": "Lucky Spin",
      "text": "Big X",
      "iconUrl": "<https://example.com/icons/mega-odds.png>",
      "buttonText": "x500",
      "gameUrl": "<https://example.com/games/mega-odds>",
      "timestamp": "2024-05-10T12:00:00Z"
    }
  ],
  "pagination": {
      "nextCursor": null,
      "hasNext": false
  }
}

Integration and Use

For successful integration of the "Big Win / Big X" widget, partners need to implement the appropriate APIs for handling requests and data feeds, as well as configure link tracking mechanisms. Widget publication can be optimized for interaction with users on the Watchers side, based on chat activity and partner preferences.

Link Open Type

This setting determines how links within the win publication widgets will be opened or handled when a user interacts with them. You can choose one of the following options:

Open in a new window
The clicked link opens in a separate browser tab or window. This option is convenient if you want users to see external pages while keeping the current chat or site session intact. It helps prevent navigation away from the chat interface, allowing the user to return easily.

Send post message
Instead of opening a new tab or window, clicking the link sends a post message event to the parent application. This method is ideal for embedded or iframe-based integrations where you need full control over what happens when a user clicks the link. You can listen for the post message event in your application and decide how to handle it (for example, displaying a modal, navigating within your own interface, or performing other custom actions). Be sure to implement the appropriate event listeners and logic in your application to handle incoming post messages properly.

postMessage example

{
   "type":"link",
   "body":{
      "action":"open",
      "data":{
         "link":"{URL}"
      }
   }
}

Implementation Tips
When using Open in a new window, ensure you track user sessions and handle any potential side effects of opening external pages (for example, ensuring that users can return to the original chat or site without losing data). When using Send post message, implement a listener in your parent application to process incoming messages. This approach offers more flexibility for custom navigation flows, UI updates, or other dynamic actions within your application.