In this post I will show you how to use ASP.NET WebHooks Preview to integrate with Stripe WebHooks. We will use the ASP.NET Stripe WebHooks Receiver beta6 for this. We could implement a WebHook receiver ourselves, in this case I am going to use the ASP.NET library as it provides us with a nice model to consume WebHooks from different providers. Some useful links:
- ASP.NET WebHooks Preview
- ASP.NET WebHooks Documentation
- Stripe WebHooks
- NuGet package for the Stripe Receiver
Creating a receiver
Lets create a new Web API project:
First we initialize the WebHookConfig by adding
config.InitializeReceiveStripeWebHooks(); to WebApiConfig.Register:
The next step is to add a WebHookHandler to our project, we use MStripeWebHookReceiver.Name to determine the receiver name:
we now have a custom handler for events sent to our stripe receiver URI:
In case of a new WebHook request, the WebHookReceiversController will try to find a receiver registered with the name “stripe”. In our case it will find the StripeWebHookReceiver which handles the incoming request and verifies the incoming data for us. Verification is done by retrieving the actual event through the Stripe API, using the ‘id’ field from the incoming WebHook request. The verification is necessary because anyone could send anything to our WebHook, by retrieving the data from Stripe you know that the data actually exists in your account. You can make use of the Stripe IP Addresses but still you’d like to check if you’re able to access the received event with your current API Key.
Registering the Stripe API Secret Key with our own application is easy. Just save your key in the Web.Config like so (or use azure app settings):
You can find your own Secret API key on the Stripe API Keys page. I am using the Test Key right now, which offers the same functionality as the Live Key exept for making actual bank transactions obviously.
Copy the key to your web.config and deploy your application somewhere. Any arbitrary location that can be accessed by the Stripe servers should be fine, both http and https are supported at the moment. There are ways to run webhooks on a dev environment but I haven’t tried it yet).
And last but not least, register your webhook URI on the WebHooks page.
Let’s test our implementation
There are two ways to test our WebHooks implementation. There are quite a lot of events, the full list can be found here.
In order to test our WebHook and the various events, we only have one option at the moment. That option is to create create actual instances of the objects that trigger events in test mode. Invoices and payments created in test mode or with the test API key will not trigger any actual payment. However in order to test for example ending trial periods, you have to create a subscription with a trial period for a user in order to trigger the event.
The Stripe Webhooks page has an option to send test webhooks. The WebHooks library however handler these events without calling our own StripeWebHookHandler though. I am currently working on a pull request which enables us to handle these test events ourselves.