Introduction #
This module allows users to connect to Patreon in order to receive pledge updates to Stream Hydra. To get started, enable the Patreon module from the modules page. To understand more about the data types returned, and how to use them, check out this article.
Triggers #
Triggers are events received from Patreon that contain various data for you to use in Stream Hydra. These triggers become active after you save/update your applet and are called in real time when the event happens. Let’s take a look at each Trigger Node in the Patreon module.
On Pledge Create #
This node will trigger your applet and return these values whenever a person pledges for the first time to your Patreon campaign.
- FULL_NAME (string) – The full name of the person who has pledged to your campaign.
- IS_FOLLOWER (boolean) – Whether the person who pledged to you is following your Patreon campaign.
- NOTE (string) – The pledge note left by the user.
- WILL_PAY_AMOUNT_CENTS (number) – The amount the user will pay for their pledge, in cents. The Patreon documentation only mentions cents with no word for other currencies. From what we have gathered, if the user pays £1 for example, this won’t get converted to USD but instead will return 100 cents as if it were pennies. This could be subject to change and we will do our best to update this accordingly.
On Pledge Update #
This node will trigger your applet and return these values whenever a person updates their pledge to your Patreon campaign.
- FULL_NAME (string) – The full name of the person who has updated their pledg to your campaign.
- IS_FOLLOWER (boolean) – Whether the person who pledged to you is following your Patreon campaign.
- NOTE (string) – The pledge note left by the user.
- WILL_PAY_AMOUNT_CENTS (number) – The amount the user will pay for their pledge, in cents. The Patreon documentation only mentions cents with no word for other currencies. From what we have gathered, if the user pays £1 for example, this won’t get converted to USD but instead will return 100 cents as if it were pennies. This could be subject to change and we will do our best to update this accordingly.
On Pledge Delete #
This node will trigger your applet and return these values whenever a person deletes their pledge to your Patreon campaign.
- FULL_NAME (string) – The full name of the person who pledged to your campaign.
- IS_FOLLOWER (boolean) – Whether the person who pledged to you is following your Patreon campaign.
- NOTE (string) – The pledge note left by the user.
- WILL_PAY_AMOUNT_CENTS (number) – The amount the user will pay for their pledge, in cents. The Patreon documentation only mentions cents with no word for other currencies. From what we have gathered, if the user pays £1 for example, this won’t get converted to USD but instead will return 100 cents as if it were pennies. This could be subject to change and we will do our best to update this accordingly.
This page will be updated as we add more support for Patreon triggers and actions. If you have any questions please feel to free to contact us here via any method – except maybe carrier pigeon!
