Skip to content
This repository was archived by the owner on Jan 23, 2021. It is now read-only.

Commit eab8fad

Browse files
Address feedback from @mg-stripe
1 parent 224e10f commit eab8fad

File tree

5 files changed

+581
-650
lines changed

5 files changed

+581
-650
lines changed

README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ Webhooks require a public URL that Stripe will ping to notify the monitor of new
3131

3232
If you have a [__Basic__](https://ngrok.com/pricing) ngrok subscription, you can specify a custom subdomain that will stay reserved for your account.
3333

34-
#### Optional: Verify Webhooks are signed
35-
[Stripe can optionally sign Webhook events to your endpoints](https://stripe.com/docs/webhooks/signatures). If you'd like the Webhook Monitor to verify these for you, simply modify the `signingSecret` value in `config.js` with the endpoint-specific signing secret key found at the bottom of the Webhook details page.
36-
37-
Unverified Webhooks will return a `400` response to Stripe, and log an error to your console.
38-
3934
### Start receiving changes
4035

4136
To start the monitor:
@@ -45,17 +40,9 @@ npm install
4540
npm start
4641
```
4742

48-
Take note of the public URL provided by ngrok: it should be listed when the monitor starts.
49-
50-
**Don't want to use ngrok?** As long as Stripe can reach the webhooks endpoint via a public URL, you'll receive updates.
51-
52-
### Subscribe to webhook notifications
53-
54-
In your Stripe Dashboard, go to the _API_ section, then click on the _Webhooks_ tab.
55-
56-
You should add a receiving endpoint by clicking _Add Endpoint_. Fill in the public URL provided by ngrok, or any other public URL that can reach the webhook monitor.
43+
A [Stripe webhook endpoint](https://stripe.com/docs/webhooks/setup) will be automatically provisioned and pointed at your ngrok tunnel, subscribed to all Stripe events.
5744

58-
![](https://raw.githubusercontent.com/stripe/stripe-webhook-monitor/master/screenshots/setting-up-webhooks.png)
45+
**Don't want to use ngrok?** As long as Stripe can reach the webhooks endpoint via a public URL, you'll receive updates. Set the `webhookSigningSecret` configuration to ensure your events are signed correctly.
5946

6047
## Troubleshooting
6148

config.sample.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ module.exports = {
55
stripe: {
66
// Include your Stripe secret key here
77
secretKey: 'YOUR_STRIPE_SECRET_KEY',
8-
signingSecret: null
8+
// If not using ngrok, include your Webhook signing secret here
9+
webhookSigningSecret: null
910
},
1011
/*
1112
Stripe needs a public URL for our server that it can ping with new events.

0 commit comments

Comments
 (0)