Kick.GiftSubscription

Someone gifts a subscription to another viewer.

• Platform: kick
• Shape: giftSub
• Source event: Kick.GiftSubscription

Usage

Widget.on("Kick.GiftSubscription", (event) => {
  // event.user, event.platform…
});

Fields

• user (string): Display name; «Anonymous» for anonymous gifts.
• userId (string): User id on its platform.
• userLogin (string): Login, lowercase.
• recipient (string): Who receives it.
• tier (1 | 2 | 3): Subscription tier.
• anonymous (boolean): Whether the gift is anonymous.
• giftBombId (string | null): Id of the gift bomb it belongs to, or null.
• fromGiftBomb (boolean): Whether it comes from a gift bomb: do not count it twice.

It also carries platform (the source platform) and raw (the original payload).

Example

The example payload that reaches the Studio simulator:

{
  "expiresAt": "string",
  "isAnonymous": false,
  "isTest": false,
  "recipient": {
    "id": "00000001000001001",
    "isSubscribed": true,
    "login": "string",
    "name": "string",
    "profilePicture": "string",
    "role": 1
  },
  "subscribedAt": "string",
  "user": {
    "id": "00000001000001001",
    "isSubscribed": false,
    "login": "string",
    "name": "string",
    "profilePicture": "string",
    "role": 1
  }
}