Ruby library for interacting with the Svix API and verifying webhook signatures
[](https://rubygems.org/gems/svix)
[](https://www.svix.com/slack/)
# Usage Documentation
You can find general usage documentation at . 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 .
# Language Support
⚡️ Features ⚡️
Officially Supported
✅
API Support
✅
Signature Verification
✅
Caveats
🚀 None!
## Installation
Add this line to your application's Gemfile:
```ruby
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.
```ruby
gem 'typhoeus`
```
And then execute:
```sh
bundle
```
Or install it yourself as:
```sh
gem install svix
```
# Development
First checkout the [core README](../README.md#development) for details on how to generate our API bindings, then follow the steps below.
## Building
```sh
bundle exec rake build
```
## Contributing
Before opening a PR be sure to format your code!
```sh
bundle exec rspec spec
```
## Running Tests
Simply run:
```sh
bundle exec rspec spec
```
## Publishing
```sh
gem build svix.gemspec
gem push pkg/svix-.gem
```
