svix 2.0.0rc2

Svix webhooks API client and webhook verification library

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

• CPython 3.9+
• uv

Installing dependencies

uv sync --frozen --all-groups

Contributing

Before opening a PR be sure to format your code!

uv run ./scripts/format.sh
uv run ./scripts/lint.sh

Running Tests

Simply run:

uv run pytest

Note that this will run integration tests that require a running Docker/Podman/etc server and working docker-compose