# Configure Patreon integration with Discourse **URL:** https://meta.discourse.org/t/configure-patreon-integration-with-discourse/62380 **Category:** Integrations **Tags:** patreon, how-to, platforms **Created:** [May 9, 2017, 6:46pm UTC](https://meta.discourse.org/t/configure-patreon-integration-with-discourse/62380 "2017-05-09T18:46:55Z") **Posts on this page:** 1 **Showing post:** 1
### Author: ![Discourse](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/discourse/32/148734_2.png) [@Discourse](https://meta.discourse.org/u/Discourse) #### Post date: [May 9, 2017, 6:46pm UTC](https://meta.discourse.org/t/configure-patreon-integration-with-discourse/62380/1 "2017-05-09T18:46:55Z")
> :bookmark: This guide explains how to set up and configure Patreon integration with your Discourse forum, including user synchronization, group management, and access control. > > :person_raising_hand: Required user level: Administrator > > :warning: Requires the Discourse Patreon plugin to be installed ## Summary This guide covers: - Setting up Patreon API credentials - Configuring the Discourse Patreon plugin - Synchronizing Patreon users with Discourse groups - Managing Patron group settings - Setting up webhooks for real-time updates - Restricting site access to Patreon supporters :exclamation: Only members who have pledged to a tier membership will be synced to Discourse groups. Free users and users under the 7-day free trial will not be synchronized. ## Creating Patreon credentials 1. Go to the [Patreon Clients & API Keys page](https://www.patreon.com/portal/registration/register-clients) 2. Click “Create Client” ![Creating a new Patreon client](https://global.discourse-cdn.com/meta/original/3X/5/b/5b376d0606891e9d490f32c09a873d695ab22f7e.png) 1. Fill in the form with these details: - App Name - Description - App Category - Author - Company Domain: `discourse.example.com` - Privacy Policy URL: `https://discourse.example.com/privacy` - Terms of Service URL: `https://discourse.example.com/tos` - Redirect URIs: `https://discourse.example.com/auth/patreon/callback` - Client API Version: Set to `1` ![Patreon client creation form](https://global.discourse-cdn.com/meta/original/3X/3/9/39c0c0891a4c8e7edbe661d6278e0163b3a32709.png) :warning: The plugin currently uses Patreon API v1 endpoints internally, so Client API Version must be set to `1`. Setting it to `2` will cause authentication errors because v2-only clients cannot access v1 endpoints. Note that Patreon has announced that API v1 will be deprecated in the future. 1. Click “Create Client” 2. Save your credentials for the next step ![Patreon credentials](https://global.discourse-cdn.com/meta/original/4X/f/4/9/f49d13d2537427ceb1739ea1888313168e0fce37.png) ## Configuring the Discourse plugin 1. Navigate to your Admin → Site Settings panel 2. Enter `Patreon` in the search bar. 3. Copy and Paste the following from your Patreon Client to Discourse : - `patreon client id` - `patreon client secret` - `patreon creator access token` - `patreon creator refresh token` ![Discourse Patreon plugin settings](https://global.discourse-cdn.com/meta/original/3X/6/4/64384fab9293c2afe06fd82d3263a93ad8a219a3.png) Optional settings: - Enable donation prompts by checking `patreon donation prompt enabled` and setting your campaign URL - Enable Patreon login by setting your `patreon creator discourse username` and checking `patreon login enabled` - Check `patreon enabled` to activate the plugin ## Synchronizing Patreon data 1. Visit `https://discourse.example.com/admin/plugins/patreon` 2. Click “Update Patreon Data & Sync Groups” ![Patreon sync interface](https://global.discourse-cdn.com/meta/original/3X/1/6/16dda57b7d2e2f53d0ca0c1df57d2e9d0d85a5ab.png) A successful sync will display a confirmation message: ![Sync confirmation](https://global.discourse-cdn.com/meta/original/3X/6/5/65c28b588dd7129dd35776c5333b82dc94988ccc.png) ## Linking Patreon tiers to Discourse groups 1. Select a Discourse group from the Group dropdown 2. Choose a Patreon reward tier from the Rewards dropdown 3. Click the Save icon ![Group linking interface](https://global.discourse-cdn.com/meta/original/3X/b/f/bf85056abaa7cae07e35092a31ec069de09346e2.png) After linking groups, click “Update Patreon Data & Sync Groups” again to sync existing users. ## Patron group customization The default Patron group includes: - Avatar flair - Patron badge To customize these: 1. Visit the Patron group page 2. Click the “Manage” tab 3. Adjust flair and group description settings ![Patron group management](https://global.discourse-cdn.com/meta/original/3X/3/a/3a5516a0ffa11d3624e0084bfe6e5a8d7fec8f81.png) ## Setting up webhooks (optional) To enable real-time synchronization: 1. Visit [Platform | Applications | Patreon](https://www.patreon.com/portal/registration/register-webhooks) 2. Create a webhook pointing to `https://discourse.example.com/patreon/webhook` ![Creating webhook](https://global.discourse-cdn.com/meta/original/3X/d/a/dab07207fb811df8360897cdd0406c83408fe231.png) 1. Enable these triggers: - Create Pledge (`pledges:create` or `members:pledge:create`) - Update Pledge (`pledges:update` or `members:pledge:update`) - Delete Pledge (`pledges:delete` or `members:pledge:delete`) ![Webhook triggers](https://global.discourse-cdn.com/meta/original/3X/5/9/59f6b0ce0f7c5ed4d340b8da00ded2658f92728c.png) 1. Copy the webhook secret to your `patreon webhook secret` site setting ## Restricting site access to Patreon supporters To limit site access to Patreon users: 1. Ensure Patreon login is working 2. Disable these settings: - `enable local logins` - `enable local logins via email` To restrict access to only your Patreon supporters: 1. Configure category security settings 2. Link categories to Patreon-connected groups ## Troubleshooting Enable verbose logging by activating the `patreon verbose log` setting. Access logs at `https://discourse.example.com/logs`. ## Additional resources - [Discourse Patreon](https://meta.discourse.org/t/discourse-patreon-integration/44366) - [Understanding groups and category permissions](https://meta.discourse.org/t/how-to-use-category-security-settings-to-create-private-categories/87678) - [Patreon Clients & API Keys](https://www.patreon.com/portal/registration/register-clients) > Last edited by @jessii 2024-11-18T20:35:57Z > > > **Check document** > > > > Perform check on document: --- _[View the full topic](https://meta.discourse.org/t/configure-patreon-integration-with-discourse/62380)._