SAMMI Integration

If you heard LurkBait can integrate with SAMMI, it indeed can! Big thanks to Landie for directing this feature, without them this would not be possible ❤️

Setting Up

LurkBait can use SAMMI Webhooks, if enabled in the LurkBait settings the app sends 4 events to SAMMI with the data outlined below.

To use a SAMMI webhook trigger, add a new button and edit its triggers. Add a Webhook Trigger and to capture a specific LurkBait event, enter the name of one of the 4 events below exactly.

For more information, I highly recommend you check out the SAMMI documation on using Webhook Triggers

Using Variables

Once you have added a button with a webhook trigger in SAMMI, data from these events can by adding a "Trigger Pull Data" command inside the button that will pull any data supplied in the webhook request body when SAMMI receives the trigger.

The "Save Variable As" field can be anything, but for the sake of this example, we will use "lurkbaitData" going forward. Enter "all" in the "Pull Value" field to pull all the data sent by LurkBait as per the events below.

Variables can then be accessed by using the using the following notation /$lurkbaitData.data.variablename$/ for example /$lurkbaitData.data.catchWeight$/ returns the catches weight, or /$lurkbaitData.data.catchName$/ returns the catches name.

For more information about using conditional logic, check out the SAMMI documentation on Statements and Loops.

LurkBait Cast Event

Triggered when cast occurs, when the users name appears on screen with the text "@username cast a line"

{
    "trigger": "LurkBait Cast", //Name of the event
    "username": "cambamthanksman",
    "displayName": "CamBamThanksMan",
    "castTrigger": "Bits", //Can return "Test", "Chat", "Points", "Bits", "Sub", "GiftSub", "API"
    "queueLength": 1 //Will return number of users in the queue, will always return 1 or more
}

LurkBait Snag Event

Triggered when cast occurs, when the users name appears with the text "@username cast a line"

{
    "trigger": "LurkBait Snag", //Name of the event
    "username": "cambamthanksman",
    "displayName": "CamBamThanksMan",
    "castTrigger": "Bits", //Can return "Test", "Chat", "Points", "Bits", "Sub", "GiftSub", "API"
    "queueLength": 1, //Will return number of users in the queue, will always return 1 or more
    "catchName": "Starfish",
    "catchDescription": "Let's call them Patrick.",
    "catchRarity": "Uncommon", //Can return "Junk", "Common", "Uncommon", "Rare", "Epic", "Legendary"
    "isCustomCatch": false,
    "catchRating": 1, //Will return between 1 and 3 corresponding to star rating
    "catchAlertLevel": 1, //Will return between 1 and 3 corresponding to ! level
    "catchValue": 28,
    "catchWeight": "0.09",
    "catchThumbnailURL": "https://blam.cam/thumbnails/Starfish_THUMB.png",
    "isNew" : "Existing" //Can return either "Existing", "New", or "NewRecord"
    "playerGold": 0,
    "playerLifetimeGold": 0,
    "playerLeaderboardGold": 0
}

LurkBait Catch Event

Triggered when catch is revealed and the Catch popup window opens. This data is the same as the Snag event, just provided at a different time in the catch sequence.

{
    "trigger": "LurkBait Catch", //Name of the event
    "username": "cambamthanksman",
    "displayName": "CamBamThanksMan",
    "castTrigger": "Bits", //Can return "Test", "Chat", "Points", "Bits", "Sub", "GiftSub", "API"
    "queueLength": 1, //Will return number of users in the queue, will always return 1 or more
    "catchName": "Starfish",
    "catchDescription": "Let's call them Patrick.",
    "catchRarity": "Uncommon", //Can return "Junk", "Common", "Uncommon", "Rare", "Epic", "Legendary"
    "isCustomCatch": false,
    "catchRating": 1, //Will return between 1 and 3 corresponding to star rating
    "catchAlertLevel": 1, //Will return between 1 and 3 corresponding to ! level
    "catchValue": 28,
    "catchWeight": "0.09",
    "catchThumbnailURL": "https://blam.cam/thumbnails/Starfish_THUMB.png",
    "isNew" : "Existing" //Can return either "Existing", "New", or "NewRecord"
    "playerGold": 0,
    "playerLifetimeGold": 0,
    "playerLeaderboardGold": 0
}

LurkBait Catch Complete Event

Triggered when gold animation completes and the Catch popup window closes.

{
    "trigger": "LurkBait Catch Complete", //Name of the event
    "username": "cambamthanksman",
    "displayName": "CamBamThanksMan",
    "castTrigger": "Bits", //Can return "Test", "Chat", "Points", "Bits", "Sub", "GiftSub", "API"
    "queueLength": 0 //Will return number of users in the queue, will return zero if nobody is left waiting
}

Docs