Svix Webhooks

Svix is an enterprise-ready webhook service that simplifies sending webhooks. Developers make a single API call, and Svix manages deliverability, retries, security, and other complexities.

Official documentation is available at docs.svix.com and complete API documentation with code examples for all client libraries can be found at api.svix.com.

The Svix Ruby library provides two primary capabilities:

1. API Support: Interacting with the Svix API.
2. Signature Verification: Verifying webhook signatures to ensure authenticity.

For detailed API documentation and code examples for each endpoint, visit https://api.svix.com. General usage guides can be found at https://docs.svix.com.

The Svix Go library provides tools for interacting with the Svix API and verifying webhook signatures.

For general usage guidance, visit https://docs.svix.com. For complete API documentation including code examples for every endpoint, visit https://api.svix.com.

The Svix C# library allows you to interact with the Svix API and verify webhook signatures.

• Signature Verification: Fully supported.
• API Support: Check the official Svix API documentation for complete endpoint details and code examples.

For general usage guidance, visit the Svix Documentation.

The Svix webhook service revolves around four primary entities:

• messages: The actual webhooks being sent, containing payload contents and metadata.
• application: The target container for messages. Typically, you should create one application per user on your platform.
• endpoint: The destination URLs where messages are delivered. An application can have multiple endpoints. Messages are sent to all endpoints subscribed to the specific event type.
• event-type: Identifiers that categorize messages. These are used to filter which messages are sent to which endpoints.

The Svix CLI provides completion scripts for bash, elvish, fish, powershell, and zsh. To generate a script for your specific shell, use:

svix completion <SHELL_NAME>

To automatically source the completion script in your shell configuration (e.g., .bashrc), you can use:

eval "$(svix completion bash)"

The svix-bridge CLI searches for a configuration file named svix-bridge.yaml or svix-bridge.json in the current working directory by default. You can also specify an alternate file location or provide configuration data directly via flags or environment variables.

Flags and Environment Variables:

• --cfg-file or SVIX_BRIDGE_CFG_FILE: Path to an alternate configuration file.
• --cfg or SVIX_BRIDGE_CFG: Configuration data supplied directly as a string.

Usage Examples:

# Using the default config file location
$ svix-bridge

# Specifying an alternate location
$ svix-bridge --cfg-file path/to/svix-bridge.json

# Config data supplied directly
$ svix-bridge --cfg '{"log_format": "json", "senders": []}'

Svix supports idempotency to allow safe retries of POST requests without duplicating operations.

To use this feature, generate a unique string (such as a UUID v4) and pass it in the Idempotency-Key header. If a subsequent request is made with the same key, Svix will return the same status code and body as the initial successful request.

Download the latest release from the GitHub releases page. To use the library, include the init.php file in your project. Note that you must have the json PHP extension installed and available.

require_once('/path/to/svix-php/init.php');

To develop with the Svix Python library, ensure you have CPython 3.9+ and uv installed. Use uv sync to install all dependencies.

uv sync --frozen --all-groups

Ensure you have Kotlin 1.9.00+ and Gradle installed, then use the Gradle wrapper to build the library.

./gradlew build

To interact with the Svix API, you must provide an authentication token. You can do this in two ways:

1. Temporarily: Set the SVIX_AUTH_TOKEN environment variable.
2. Persistently: Run the login command to interactively configure your credentials in a config file.

# Temporary
export SVIX_AUTH_TOKEN=<MY-AUTH-TOKEN>

# Persistent
svix login