PHP library for interacting with the Svix API and verifying webhook signatures
[](https://packagist.org/packages/svix/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
## Composer
Install via [Composer](https://getcomposer.org/):
```sh
composer require svix/svix
```
Autoload dependencies:
```php
require __DIR__ . '/vendor/autoload.php';
```
## Manual Installation
For now you can download the [latest release](https://github.com/svix/svix-webhooks/releases). Then, to use the bindings, include the `init.php` file.
```php
require_once('/path/to/svix-php/init.php');
```
### Required Dependencies
Svix PHP requires the following extensions in order to run:
- [`json`](https://secure.php.net/manual/en/book.json.php)
If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.
# Development
First checkout the [core README](../README.md#development) for details on how to generate our API bindings, then follow the steps below.
## Requirements
- PHP >= 5.6.0
## Building the library
```sh
dotnet build
```
## Contributing
Before opening a PR be sure to format your code!
```sh
composer install
./vendor/bin/php-cs-fixer fix -v --using-cache=no .
```
## Running Tests
Simply run:
```sh
composer install
./vendor/bin/phpunit php/tests
```
