Setting up a Stripe Webhook

If you are using our Stripe extension, you should set up a webhook in your Stripe account.

What is a webhook?

Webhooks allow Stripe to send messages to your website when certain “events” take place. For example, if a payment is refunded in Stripe, Stripe can automatically send a notification to your webhook to let it know.

Charitable uses webhooks to automatically process refunds, mark recurring donation subscriptions as active (with Recurring Donations) and check the status of accounts created with the Stripe Connect integration.

How to create your webhook

To set this up, you will need to register a new webhook in your Stripe account.

  1. Log into your Stripe dashboard.
  2. From the menu on the left, click on API.
  3. Click on the Webhooks tab.

    The Webhooks interface in Stripe (as of 2017).

  4. Click on + Add endpoint.
  5. The webhook URL takes the form of https://yoursite.com/?charitable-listener=stripe
  6. Click Add endpoint.

Once you have added that, Stripe will automatically start sending messages to your website, and Charitable will pick those up and handle the rest.

Note that if you have test mode enabled on your website, you should create a separate webhook endpoint for the test data. To do that, first toggle on “View test data” mode in the Stripe dashboard and then follow the steps above to add the endpoint.