Extensions

Extend SAMMI's functionality with our community made extensions.

Patreon Triggers

Developed by:
Rating | Social | views

Overview

Patreon events delivered straight to your SAMMI!

Honoring your loyal Patrons and automatically thanking for their contributions while you stream is now finally possible with this extension!

Triggers
Create, Update and Delete member - every time someone follows you or pledges to you
Create, Update and Delete Member pledge - every time someone pledges to you and becomes your patron

Important Note
There are testing buttons on Patreon for all the triggers. However, they tend to deliver slightly different payloads than the real events. The extension is configured for real events.


Special thanks goes to:
SteveLevesque and Djargic for their continued support on Github.
The Argamenmock, EndoSkull, Evan, Panic, DoctorFu, kurocha, Stephen, Ethan, griddark, Kenny, Mill, William, Paul, deaffrasier, Venge, PapaBear Does Stuff, TTarantox, Rodrigo, Harvey Toadface, Alchemy_03, REVAMPEDDRDTH37 Williams, RhinoMonsterGC, JimmyPotato, Bryan, my amazing Patrons!
Landie and Andilippi for helping me test the extension!

If you would like to support me in creating more extensions for SAMMI, you can navigate to the Donate section.

Need a custom tailored extension? Head to the Commissions section!

DISCLAIMER: The extension is provided as is. The developer has no obligation to provide maintenance and support services or handle any bug reports.
Feel free to edit the extension for your own use. You may not distribute, sell or publish it without the author’s permission.


Additional Information
Version 1.0 Requires SAMMI 1.42, 2.05^ Stream Platform Any Updated February 20, 2022
Setup

You can follow all the steps below while watching the video guide. Please note this video guide was originally recorded with LioranBoard 1, however the setup is the exact same (just the buttons look a bit different).

  1. Install the extension. You can follow the Extension Install Guide.
  2. Reload your Bridge. It must be running at all times for the extension to function properly.
  3. Go to the Patreon premade deck in your SAMMI Receiver and edit the red INIT button. In the Patron Triggers INIT command edit the following boxes:
    • Itch Key = key you received upon purchase on Itch.io page (the link will be in your email too)
      Itch key redeem example
      Itch key redeem example
    • Websocket Token = retrieve yours using your Itch key below
    • Webhok Secret = go to Patreon webhook page
      • Paste this url next to the + button (double check your itch key in the url is correct: https://lioranboard-websocket-7we7k.ondigitalocean.app/patreonhook/YOUR_ITCH_KEY
      • Click on the + button to add the webhook.
      • Activate all non deprecated events.
      • Click on COPY SECRET and paste it into Webhok Secret.
  4. Once you’re done editing the INIT button, press Save and Save again until you’re in the main menu.
  5. Refresh your Bridge. Press the INIT button. You should now see connected in your Patreon tab in Bridge.
    You should not need to press the INIT button manually again as there’s a trigger attached to it which will press it for you every time you reload Bridge.
  6. Go back to your Patreon webhook page and click on the Send test buttons.
  7. Your premade buttons should activate and a premade chat message should show up in your Twitch chat (if connected to Twitch).

The test buttons have slightly different (wrong) payload than real events. This extension was tested with real events. Math: Trigger pull might not work correctly with test events.

Triggers

Members Create
Triggers when a new member is created, either by pledging or by following a campaign.
Extension Trigger: Patreon Members Create

Members Update
Triggers when a membership has been updated.
Extension Trigger: Patreon Members Update b

Members Delete
According to the documentation it triggers when an existing membership is deleted.
However, in my own tests unfollowing Patreon user actually triggered Members Edit instead.
Extension Trigger: Patreon Members Delete

The following Trigger Pull Data values are the same for Members Create, Update and Delete triggers

Trigger Pull Data Value Description
name Full name of the new member.
userId User ID of the member.
isFollower Member status. True = member is a follower, false = member is not a follower
status Pledge status. Can be none (for non patrons), active_patron, declined_patron or former_patron

Pledge Create
Triggers when a new member is creatd by pleding or an existing member who is following converts to pledging member.
Extension Trigger: Patreon Members Pledge Create

Pledge Update
Triggers when the pledge on a membership has been updated.
Extension Trigger: Patreon Members Pledge Update

Pledge Delete
Triggers when an existing pledge on a membership is deleted.
Extension Trigger: Patreon Members Pledge Delete

The following Trigger Pull Data values are the same for Pledge Create, Update and Delete triggers

Trigger Pull Data Value Description
name Full name of the new patron.
userId User ID of the patron.
email Patron’s email.
status Pledge status. Can be none (for non patrons), active_patron, declined_patron or former_patron
currentAmount The amount in cents that the member is entitled to. Current pledge or payment that covers the current payment period.
totalAmount The total amount in cents that the member has ever paid to the campaign in campaign’s currency.
months Number of months between charges.
tiers Array of all tier IDs the patron is entitled to
Privacy Policy
This developer has disclosed that it will not collect or use your data.

This developer declares that your data is:

  • Not being sold to third parties.
  • Not being used or transferred for purposes that are unrelated to the extension's core functionality
  • Not being used or transferred to determine creditworthiness or for lending purposes

Reviews

Coming soon!