Patreon¶
Getting started with Patreon¶
The Patreon modules allow you to monitor new members, new pledges, member updates, pledge updates, member and pledge deletion, search members and retrieve campaign's details in your Patreon account.
Prerequisites
- A Patreon account
In order to use Patreon with Ibexa Connect, it is necessary to have a Patreon account. If you do not have one, you can create a Patreon account at patreon.com/create.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Patreon to Ibexa Connect¶
To connect your Patreon account to Ibexa Connect, follow the general instructions for Connecting to services.
After you click the Continue button, Ibexa Connect will redirect you to the Patreon website where you will be prompted to grant Ibexa Connect access to your account.
Confirm the dialog by clicking the Allow button.
Triggers¶
Watch New Members¶
The module triggers when a new member is created, either by pledging or by following a campaign.
| Webhook name | Enter the desired webhook name. |
| Campaign ID | Select the ID of the campaign you want to monitor for new members. |
Watch New Pledges¶
The module triggers when a new pledge is created for a member. This includes when a member is created through pledging, and when a follower becomes a patron.
| Webhook name | Enter the desired webhook name. |
| Campaign ID | Select the ID of the campaign you want to monitor for new pledges. |
Watch Member Updates¶
The module triggers when membership information is changed. It includes updates on payment charging events.
| Webhook name | Enter the desired webhook name. |
| Campaign ID | Select the ID of the campaign you want to watch for member updates. |
Watch Pledge Updates¶
Triggers when a member updates their pledge.
| Webhook name | Enter the desired webhook name. |
| Campaign ID | Select the ID of the campaign you want to watch for pledge updates. |
Watch Deleted Members¶
Triggers when a membership is deleted (e.g. the member unfollows you). Note that you may get more than one of these per patron if they delete and renew their membership. Deletion only occurs if no prior payment happened, otherwise pledge deletion is an update to member status.
| Webhook name | Enter the desired webhook name. |
| Campaign ID | Select the ID of the campaign you want to watch for deleted members. |
Watch Deleted Pledges¶
The module is triggered when a member deletes their pledge.
| Webhook name | Enter the desired webhook name. |
| Campaign ID | Select the ID of the campaign you want to watch for deleted pledges. |
Actions¶
Get a Campaign¶
Returns information about a selected campaign.
| Campaign ID | Select the ID of the campaign you want to retrieve information about. |
Get a Member¶
Retrieves a particular member's details.
| Member's ID | Enter (map) the user ID of the member you want to retrieve information about. |
Searches¶
Get Campaign Members¶
Retrieves members from a selected campaign.
| Campaign ID | Select the ID of the campaign you want to retrieve member information from. |