Svix - Webhooks as a service
Website | Documentation | Community Slack
Ruby library for interacting with the Svix API and verifying webhook signatures
Usage Documentation
You can find general usage documentation at https://docs.svix.com. For complete API documentation with code examples for each endpoint in all of our official client libraries head over to our API documentation site at https://api.svix.com.
Language Support
⚡️ Features ⚡️ | |
---|---|
Officially Supported | ✅ |
API Support | ✅ |
Signature Verification | ✅ |
Caveats | 🚀 None! |
Installation
Add this line to your application's Gemfile:
gem 'svix'
If you are using svix to send outgoing webhhooks, you should also install the typhoeus
gem.
If you are only using svix to consume incoming webhooks, you do not need it.
gem 'typhoeus`
And then execute:
bundle
Or install it yourself as:
gem install svix
Development
First checkout the core README for details on how to generate our API bindings, then follow the steps below.
Building
bundle exec rake build
Contributing
Before opening a PR be sure to format your code!
bundle exec rspec spec
Running Tests
Simply run:
bundle exec rspec spec
Publishing
gem build svix.gemspec
gem push pkg/svix-<VERSION>.gem