Svix webhooks API client and webhook verification library
Project description
Svix - Webhooks as a service
Website | Documentation | Community Slack
Python 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
pip install Svix
Usage
Please refer to the documentation or the API reference for more usage instructions.
Async
from svix.api import SvixAsync, ApplicationIn
svix = SvixAsync("AUTH_TOKEN")
app = await svix.application.create(ApplicationIn(name="Application name"))
Sync
from svix.api import Svix, ApplicationIn
svix = Svix("AUTH_TOKEN")
app = svix.application.create(ApplicationIn(name="Application name"))
Development
First checkout the core README for details on how to generate our API bindings, then follow the steps below.
Requirements
- python 3
Installing dependencies
python -m venv .venv
pip install -r requirements.txt && pip install -r requirements-dev.txt
./scripts/generate_openapi.sh
Contributing
Before opening a PR be sure to format your code!
./scripts/format.sh
Running Tests
Simply run:
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.