Creating API keys and Webhooks for Patreon Integration

Creating the API Keys

API keys are needed to tie your Patreon account into your Space. We use the API keys you provide us to configure your instance so that it can pull in your tiers, and so that your Space can recognize the tiers of users logging in with Patreon.

  • Navigate to https://www.patreon.com/portal/registration/register-clients. You may be prompted to log into your Patreon creator account.
  • Click "Create Client". Enter the following details in
    • App Name (required): Catbox Spaces
    • Description (required): API integration to pull user tiers for Catbox Spaces instance
    • App Category: Member Benefits
    • Author or Company Name: Catbox LLC
    • Company Domain: yourdomain.catbox.cloud
      • Replace yourdomain.catbox.cloud with your domain if you are bringing your own domain.
    • Icon URL: Leave blank.
    • Privacy Policy URL: https://catbox.tech/legal.php 
    • Terms of Service URL: https://catbox.tech/legal.php
    • Redirect URIs: https://yourdomain.catbox.cloud/user/dologin.php https://yourdomain.catbox.cloud/administration/integratePatreon.php
      • Again, replace yourdomain.catbox.cloud with your domain if you are bringing your own domain.
    • Client API Version: 2
  • Click "Create Client".
  • Once created, you should be presented with the following: Client IDClient SecretCreator's Access Token, and Creator's Refresh Token. Please note these keys, as you will need to provide them to us to create the integration on your Space.

Creating the Webhook

We need to create a Webhook in Patreon for when a user deletes or modifies their pledge. Since your Space keeps track of the user's tier internally, it would not be good if they pledged to you, signed in, and then deleted their pledge! Creating a webhook prevents this.

  • Navigate to https://www.patreon.com/portal/registration/register-clients. On the left hand column, under "Applications", click "My Webhooks".
  • In the box labeled "Create a new webhook by pasting your URL here", paste the following URL:
    • https://yourdomain.catbox.cloud/internals/webhook.php
      • If you are bringing your own domain, change yourdomain.catbox.cloud to the domain you are using.
  • Click the "+" button to add the endpoint.
  • You should now have a list of events. We're going to enable "Update Member Pledge" and "Delete Member Pledge". Check the buttons next to them.
  • Please also copy down the secret key provided under the events. You will need to provide this to us so we can authenticate the webhook on your Space.

 

Notes about Patreon integration

  • During Provisioning, if you added on the Subscription Platform Integration (SPI) feature during purchasing, we will enable your Space to be compatible with Patreon and Subscribestar.
  • During Setup, we will reach out to you in order to receive your keys from the above steps. If you aren't ready to enable SPI, no worries! You can continue without it, and we can enable it at any future date.
  • After we have received your keys, we will configure your Space to use those keys. We have to do this part due to the way the Patreon API works with regards to URLs and Keys. 
  • Once we have configured your Space with the keys (usually within 2-4 hours of receiving your keys), we will let you know you are ready to pull in your tiers! This can be completed from the "Manage Integrations" area of your Administration panel on your Space.
  • If you add or remove tiers, you need to submit a support ticket so we can re-enable tier pulling.

Contact Our Team

If you still can't find an answer to what you're looking for, or you have a specific question, open a new ticket and we'd be happy to help!

Contact Us