SAMMI Extensions
Patreon Triggers
Patreon events delivered straight to your SAMMI!
Honor your Patrons and automatically thank them for their contributions while you stream!
Features
Triggers
Create, Update, and Delete Member
Triggered whenever someone follows or pledges to you.Create, Update, and Delete Member Pledge
Activated when someone pledges to your campaign or becomes a Patron.
Important Note
The Patreon test buttons tend to deliver slightly different payloads than real events. This extension is configured for real events.
Setup
You can follow all the steps below while watching the video guide.
Note: This video guide was originally recorded with LioranBoard 1, but the setup is identical (with slightly different button appearances).
Install the extension. You can follow the Extension Install Guide.
Reload your Bridge
The Bridge must always be running for the extension to function.Configure the Patreon Deck in SAMMI
Edit the red INIT button in the premade Patreon deck and configure the following fields:Itch Key
Enter the key you received upon purchase on Itch.io.Websocket Token
Retrieve yours using the Itch key below.Webhook Secret
Go to Patreon webhook page and paste the provided URL next to the "+" button. Ensure your Itch key in the URL is correct:https://lioranboard-websocket-7we7k.ondigitalocean.app/patreonhook/YOUR_ITCH_KEY
Then, activate all non-deprecated events and copy the secret to paste into Webhook Secret.
Save Changes
After editing the INIT button, press Save twice to return to the main menu.Test with Patreon Webhooks
Go back to the Patreon webhook page and click the "Send Test" buttons. This should activate premade buttons, sending a chat message to your connected Twitch chat (if applicable).Note: Test buttons deliver slightly inaccurate payloads. The extension is configured for real events, so math trigger pulls may not work with test events.
Triggers
Members Create
Triggers when a new member is created, either by pledging or following a campaign.
Extension Trigger: Patreon Members Create
<div class="alert alert-warning" role="alert">For new pledges, both Members Create and Pledge Create triggers will fire.</div>
Members Update
Triggered when a membership is updated.
Extension Trigger: Patreon Members Update
<div class="alert alert-warning" role="alert">If someone cancels their pledge, both Members Update and Pledge Delete triggers will fire.</div>
Members Delete
According to the documentation, this triggers when a membership is deleted. However, tests showed unfollowing a user triggers Members Edit instead.
Extension Trigger: Patreon Members Delete
The following Trigger Pull Data values apply to Members Create, Update, and Delete triggers:
Trigger Pull Data Value | Description |
---|---|
name | Full name of the member |
userId | User ID of the member |
isFollower | True if the member is a follower, else false |
status | Pledge status: none , active_patron , declined_patron , or former_patron |
{:class='table table-primary w-auto table-hover'} |
Adjusting Triggers
If you only want pledge or member triggers, adjust your settings on the Patreon Webhook page.
Pledge Create
Triggers when a new member pledges or a follower converts to a patron.
Extension Trigger: Patreon Members Pledge Create
Pledge Update
Triggers when a membership pledge is updated.
Extension Trigger: Patreon Members Pledge Update
Pledge Delete
Triggered when a pledge on a membership is deleted.
Extension Trigger: Patreon Members Pledge Delete
The following Trigger Pull Data values apply to Pledge Create, Update, and Delete triggers:
Trigger Pull Data Value | Description |
---|---|
name | Full name of the patron |
userId | User ID of the patron |
Patron's email | |
status | Pledge status: none , active_patron , declined_patron , or former_patron |
currentAmount | Current pledge amount in cents (for the current period) |
totalAmount | Total amount in cents the patron has ever paid |
months | Number of months between charges |
tiers | Array of all tier IDs the patron is entitled to |
{:class='table table-primary w-auto table-hover'} |
Get Help
Please see Troubleshooting for common extensions issues.