stripetunnel
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

StripeTunnel

Locally tunnel Stripe webhooks to your application.

WARNING: Using this in production is strongly discouraged. This project uses development APIs which may exhibit catastrophic bugs, and are not officially supported for production use by Stripe.

This project reimplements the functionality of the Stripe CLI stripe listen command to allow webhook listening to be done programatically. This can be useful in situations where you have a shared development/staging server that is not publicly accessible over the internet, but still want to receive Stripe webhooks for testing purposes.

Using this project over stripe listen allows for programmatic integration with your webhook code without having to install and interface with command line tools from your code, allowing portability if you intend to deploy your code numerous times.

This project uses undocumented endpoints. In the future, Stripe CLI may opt to provide these features, or implement security features to prevent this project from interacting with their API. If these features become part of Stripe's SDKs, please open an issue so I can update this repository to point to it. If this project breaks, please also open an issue so I can work on a fix.

Contributing

Currently, this project does not support all the features of Stripe CLI and can be improved. Take a look at TODO.md for more information about features that could be suitable for a pull request.

Support and Warranty

This project is provided free of charge with no warranty. While the project continues to be used in my projects, it will remain actively maintained. After that, updates will happen on a best-effort basis once issues are reported; however, pull requests to improve the project will always be considered.
Read the LICENSE

You can contact me via email at mem@mem.rip.

Package Sidebar

Install

npm i stripetunnel

Weekly Downloads

12

Version

0.0.2

License

MIT

Unpacked Size

72.2 kB

Total Files

9

Last publish

Collaborators

  • memcorrupt