Svix

https://github.com/svix/svix-webhooks
Admin
Svix is an enterprise-ready webhook service that handles deliverability, retries, security, and...
Tokens:809,592
Snippets:5,467
Trust Score:9
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Svix CLI globally and run help

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Install the Svix CLI globally via npm and then run it. After installation, the svix-cli command is available globally.

```sh
npm install -g svix-cli
svix-cli --help
```

--------------------------------

### Install dependencies for development

Source: https://github.com/svix/svix-webhooks/blob/main/php/README.md

Run composer install to install the library's dependencies for development.

```sh
composer install
```

--------------------------------

### Install SQLx CLI

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Install the SQLx CLI for database migrations.

```bash
$ cargo install sqlx-cli
```

--------------------------------

### Install Svix with npm or yarn

Source: https://github.com/svix/svix-webhooks/blob/main/javascript/README.md

Install the Svix library using npm or yarn. The example shows both commands as alternatives.

```sh
npm install svix
# or
yarn add svix
```

--------------------------------

### Manual installation include init.php

Source: https://github.com/svix/svix-webhooks/blob/main/php/README.md

For manual installation, include the init.php file from the downloaded release.

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

--------------------------------

### Install Svix Python library

Source: https://github.com/svix/svix-webhooks/blob/main/python/README.md

Install the Svix Python library from PyPI.

```sh
pip install svix
```

--------------------------------

### Install cargo-watch

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Install cargo-watch for automatic reload during development.

```bash
$ cargo install cargo-watch
```

--------------------------------

### Set up Docker development environment

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Set up a dockerized development environment by copying the development.env file and starting Docker Compose.

```bash
# From the svix inner directory
cp development.env .env
# Set up docker (may need sudo depending on your setup)
docker compose up
```

--------------------------------

### Format code with dotnet-format

Source: https://github.com/svix/svix-webhooks/blob/main/csharp/README.md

Formats the codebase. Install dotnet-format before running.

```sh
dotnet-format
```

--------------------------------

### Install Rust components

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Install the required Rust components: clippy, rust-src, cargo, and rustfmt.

```bash
$ rustup component add clippy rust-src cargo rustfmt
```

--------------------------------

### Build Svix server from source

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Clone the repository, change to the server directory, and build the Svix server using cargo install.

```bash
# Clone the repository
git clone https://github.com/svix/svix-webhooks
# Change to the source directory
cd svix-webhooks/server/
# Build
cargo install --path svix-server
```

--------------------------------

### Get completion help

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Run this command to see detailed instructions on configuring shell completions.

```sh
svix completion --help
```

--------------------------------

### Install Svix PHP via Composer

Source: https://github.com/svix/svix-webhooks/blob/main/php/README.md

Use Composer to install the svix/svix package. This is the recommended installation method.

```sh
composer require svix/svix
```

--------------------------------

### Install dependencies with Bundler

Source: https://github.com/svix/svix-webhooks/blob/main/ruby/README.md

Installs the gem and its dependencies using Bundler after adding it to the Gemfile.

```sh
bundle
```

--------------------------------

### Build the library with yarn

Source: https://github.com/svix/svix-webhooks/blob/main/javascript/README.md

Install dependencies and build the library using yarn.

```sh
yarn
yarn build
```

--------------------------------

### Install development dependencies with uv

Source: https://github.com/svix/svix-webhooks/blob/main/python/README.md

Install development dependencies using uv with frozen lockfile and all groups.

```sh
uv sync --frozen --all-groups
```

--------------------------------

### Create Svix client and application

Source: https://github.com/svix/svix-webhooks/blob/main/javascript/README.md

Import the Svix class, instantiate it with an authentication token, and create an application. This is the basic usage example.

```js
import { Svix } from "svix";

const svix = new Svix("AUTH_TOKEN");
const app = await svix.application.create({ name: "Application name" });
```

--------------------------------

### Install Svix CLI on Windows via PowerShell

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Install the Svix CLI on Windows using the PowerShell installer. The script installs binaries to ~/.svix/bin and adds this directory to your PATH by default.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://github.com/svix-onelson/svix-webhooks/releases/download/v2.7.0/svix-cli-installer.ps1 | iex"
```

--------------------------------

### Install Svix CLI on Linux/macOS via shell script

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Install the Svix CLI on Linux or macOS using the shell script installer. The script installs binaries to ~/.svix/bin and adds this directory to your PATH by default.

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/svix/svix-webhooks/releases/download/v2.7.0/svix-cli-installer.sh | sh
```

--------------------------------

### Configure svix-server with config.toml

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Configuration file example for svix-server. Place this in a file named config.toml in the current working directory. The jwt_secret should be securely generated, db_dsn only supports postgres, and redis_dsn can be left empty if not using redis.

```toml
# The JWT secret for authentication - should be secret and securely generated
jwt_secret = "8KjzRXrKkd9YFcNyqLSIY8JwiaCeRc6WK4UkMnSW"

# The DSN for the database. Only postgres is currently supported.
db_dsn = "postgresql://postgres:postgres@pgbouncer/postgres"

# The DSN for redis (can be left empty if not using redis)
redis_dsn = "redis://redis:6379"

# What kind of message queue to use.
queue_type = "redis"
```

--------------------------------

### Run Svix server with Docker Compose

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Starts the Svix server with Docker Compose, which also boots and configures Redis and PostgreSQL. Requires Docker Compose v2.

```bash
cd server
docker compose up
```

--------------------------------

### Install gem directly

Source: https://github.com/svix/svix-webhooks/blob/main/ruby/README.md

Installs the svix gem directly from RubyGems without a Gemfile.

```sh
gem install svix
```

--------------------------------

### Run tests with PHPUnit

Source: https://github.com/svix/svix-webhooks/blob/main/php/README.md

Run the test suite using PHPUnit after installing dependencies.

```sh
composer install
./vendor/bin/phpunit php/tests
```

--------------------------------

### Configure svix-server with environment variables

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Environment variable equivalent of the config.toml example. Variables are prefixed with SVIX_ and use uppercase names. Can be passed directly or set in a .env file.

```plaintext
# The JWT secret for authentication - should be secret and securely generated
SVIX_JWT_SECRET = "8KjzRXrKkd9YFcNyqLSIY8JwiaCeRc6WK4UkMnSW"

# The DSN for the database. Only postgres is currently supported.
SVIX_DB_DSN = "postgresql://postgres:postgres@pgbouncer/postgres"

# The DSN for redis (can be left empty if not using redis)
SVIX_REDIS_DSN = "redis://redis:6379"

# What kind of message queue to use.
SVIX_QUEUE_TYPE = "redis"
```

--------------------------------

### Build Svix Bridge from source with cargo install

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Clones the svix-webhooks repository, changes to the bridge directory, and builds the bridge using cargo install. Requires a working Rust compiler, typically installed via rustup. System dependencies are needed; see the Dockerfile for a reference.

```bash
# Clone the repository
git clone https://github.com/svix/svix-webhooks
# Change to the source directory
cd svix-webhooks/bridge/
# Build
cargo install --path svix-bridge

```

--------------------------------

### Autoload dependencies with Composer

Source: https://github.com/svix/svix-webhooks/blob/main/php/README.md

After installing via Composer, include the autoload file to load all dependencies.

```php
require __DIR__ . '/vendor/autoload.php';
```

--------------------------------

### RabbitMQ sender with environment variables

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Example RabbitMQ sender configuration using environment variable expansion with ${...} notation. If a variable lookup fails, the raw text is left as-is.

```yaml
senders:
  - name: "send-webhooks-from-${QUEUE_NAME}"
    input:
      type: "rabbitmq"
      uri: "${MQ_URI}"
      queue_name: "${QUEUE_NAME}"
    output:
      type: "svix"
      token: "${SVIX_TOKEN}"
```

--------------------------------

### Run Svix CLI with npx

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Run the Svix CLI directly with npx without installing anything. Useful for a quick check of available commands.

```sh
npx svix-cli --help
```

--------------------------------

### Example JWT and decoded payload

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Example valid JWT for the secret 'x' showing the decoded structure. The token uses the HS256 algorithm and includes the required 'sub' field set to 'org_23rb8YdGqMT0qIzpgGwdXfHirMu'.

```js
// JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE2NTUxNDA2MzksImV4cCI6MTk3MDUwMDYzOSwibmJmIjoxNjU1MTQwNjM5LCJpc3MiOiJzdml4LXNlcnZlciIsInN1YiI6Im9yZ18yM3JiOFlkR3FNVDBxSXpwZ0d3ZFhmSGlyTXUifQ.USMuIPrqsZTSj3kyWupCzJO9eyQioBzh5alGlvRbrbA
// Structure (when decoded):
{
  "iat": 1655140639,
  "exp": 1970500639,
  "nbf": 1655140639,
  "iss": "svix-server",
  "sub": "org_23rb8YdGqMT0qIzpgGwdXfHirMu"
}
```

--------------------------------

### Set stable Rust toolchain

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Set the stable Rust toolchain as the default, required before installing components.

```bash
$ rustup default stable
```

--------------------------------

### CLI: Populate request body from file with @filename syntax

Source: https://github.com/svix/svix-webhooks/blob/main/ChangeLog.md

Use cURL-style @filename syntax to populate a request body from a file when creating a streaming event. The example shows the command with a placeholder event ID and filename.

```bash
svix streaming events create strm_abcdef123456789 @filename.json
```

--------------------------------

### Run SQL migrations

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Run SQL migrations from the directory containing the .env file.

```bash
cargo sqlx migrate run
```

--------------------------------

### Build the Svix Java library

Source: https://github.com/svix/svix-webhooks/blob/main/java/README.md

Run this command to build the library using Gradle.

```sh
./gradlew build
```

--------------------------------

### Build the C# library with dotnet build

Source: https://github.com/svix/svix-webhooks/blob/main/csharp/README.md

Builds the Svix library. Requires .NET 5.0 or later.

```sh
dotnet build
```

--------------------------------

### Run svix-bridge with default, --cfg-file, or --cfg

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Shows three ways to run svix-bridge: using the default config file, specifying an alternate location with --cfg-file, or supplying config directly with --cfg. The environment variables SVIX_BRIDGE_CFG_FILE and SVIX_BRIDGE_CFG can also be used.

```bash
# 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": []}'
```

--------------------------------

### Interacting with the Svix server

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Shows how to authenticate with the Svix server using the `SVIX_AUTH_TOKEN` environment variable or the `svix login` command, then create an application and list applications with the `svix application` commands.

```sh
# Set your Auth Token temporarily via the SVIX_AUTH_TOKEN environment variable
export SVIX_AUTH_TOKEN=<MY-AUTH-TOKEN>
# or to persistently store your auth token in a config file run
svix login # interactively configure your Svix API credentials

# Create an Application with the name "Demo"
svix application create '{ "name": "demo" }'

# List Applications
svix application list --limit 2 --iterator some_iterator
```

--------------------------------

### Run Go tests with go test

Source: https://github.com/svix/svix-webhooks/blob/main/go/README.md

Execute this command to run the full test suite for the library. It is the standard way to verify changes locally.

```sh
go test ./...
```

--------------------------------

### Async usage: create application with SvixAsync

Source: https://github.com/svix/svix-webhooks/blob/main/python/README.md

Use the async client to create an application. Requires an auth token and an application name.

```python
from svix.api import SvixAsync, ApplicationIn

svix = SvixAsync("AUTH_TOKEN")
app = await svix.application.create(ApplicationIn(name="Application name"))
```

--------------------------------

### Run development server with cargo watch

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Run the auto-reloading development server from the svix-server directory.

```bash
# Move to the inner svix-server directory.
cd svix-server
cargo watch -x run
```

--------------------------------

### Lint and format code

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Run linting and formatting before pushing code.

```bash
cargo clippy --fix
cargo fmt
```

--------------------------------

### Svix CLI basic usage

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Shows the basic usage of the Svix CLI, including the `svix help` command and the `--help` flag for detailed command information.

```sh
svix [command]

# Run `svix help` for information about the available commands
svix help

# or add the `--help` flag to any command for a more detailed description and list of flags
svix [command] --help
```

--------------------------------

### svix listen command and output

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

The `listen` command creates a public URL that forwards requests to a local URL. The output shows the generated endpoint and the local forwarding target. No Svix account is required.

```sh
svix listen http://localhost:8000/webhook/
```

```sh
Webhook Relay is now listening at:
https://play.svix.com/in/c_tSdQhb4Q5PTF5m2juiWu8qFREqE/

All requests on this endpoint will be forwarded to your local URL:
http://localhost:8080/webhook/

View logs and debug information at:
https://play.svix.com/view/c_tSdQhb4Q5PTF5m2juiWu8qFREqE/
```

--------------------------------

### Sync usage: create application with Svix

Source: https://github.com/svix/svix-webhooks/blob/main/python/README.md

Use the sync client to create an application. Requires an auth token and an application name.

```python
from svix.api import Svix, ApplicationIn

svix = Svix("AUTH_TOKEN")
app = svix.application.create(ApplicationIn(name="Application name"))
```

--------------------------------

### Run tests for the Svix Java library

Source: https://github.com/svix/svix-webhooks/blob/main/java/README.md

Run this command to execute the test suite.

```sh
./gradlew test
```

--------------------------------

### Publish the gem

Source: https://github.com/svix/svix-webhooks/blob/main/ruby/README.md

Builds the gem and pushes it to RubyGems.

```sh
gem build svix.gemspec

gem push pkg/svix-<VERSION>.gem
```

--------------------------------

### Publish Svix Java library to Maven

Source: https://github.com/svix/svix-webhooks/blob/main/java/README.md

Run this command to publish the library to Sonatype and release the staging repository.

```sh
./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository
```

--------------------------------

### Build the gem

Source: https://github.com/svix/svix-webhooks/blob/main/ruby/README.md

Builds the gem package using Rake.

```sh
bundle exec rake build
```

--------------------------------

### View and revert SQL migrations

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

View migration status and revert the latest migration.

```bash
# View the migrations and their status
cargo sqlx migrate info
# Reverting the latest migration
cargo sqlx migrate revert
```

--------------------------------

### Format and lint code with uv scripts

Source: https://github.com/svix/svix-webhooks/blob/main/python/README.md

Format and lint the codebase before opening a PR.

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

--------------------------------

### Create new SQL migration

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Generate a new SQL migration with both up and down scripts.

```bash
cargo sqlx migrate add -r MIGRATION_NAME
```

--------------------------------

### Create application for operational webhooks

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Creates an application in the service account to enable operational webhooks for the default organization. Uses the JWT generated for the service account as the Bearer token.

```bash
curl -X 'POST' \
  'http://localhost:8071/api/v1/app/' \
  -H 'Authorization: Bearer op_webhook_token_123' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Operational webhook for default org",
        "uid": "org_23rb8YdGqMT0qIzpgGwdXfHirMu"
    }'
```

--------------------------------

### Run Svix server standalone with Docker

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Runs the Svix server as a standalone container, requiring environment variables pointing to Redis and PostgreSQL. Uses the --env-file flag to load settings from development.env.

```bash
docker run \
  --name svix-server \
  -p 8071:8071 \
  --env-file development.env \
  svix/svix-server
```

--------------------------------

### Run tests with yarn test

Source: https://github.com/svix/svix-webhooks/blob/main/javascript/README.md

Execute the test suite using yarn.

```sh
yarn test
```

--------------------------------

### Format Go code with go fmt

Source: https://github.com/svix/svix-webhooks/blob/main/go/README.md

Run this command in the repository root to format all Go source files before opening a pull request. It is required as part of the contributing workflow.

```sh
go fmt ./...
```

--------------------------------

### Publish NuGet package with dotnet nuget push

Source: https://github.com/svix/svix-webhooks/blob/main/csharp/README.md

Pushes the built .nupkg package to the NuGet registry. Replace the path and API key.

```sh
dotnet nuget push path/to/Svix.X.X.X.nupkg --api-key XXXXX --source https://api.nuget.org/v3/index.json
```

--------------------------------

### Run tests with dotnet test Svix.Tests

Source: https://github.com/svix/svix-webhooks/blob/main/csharp/README.md

Runs the test suite for the Svix.Tests project.

```sh
dotnet test Svix.Tests
```

--------------------------------

### Generate auth token

Source: https://github.com/svix/svix-webhooks/blob/main/server/README.md

Generate an authentication token for development.

```bash
cargo run jwt generate
```

--------------------------------

### Run tests with pytest

Source: https://github.com/svix/svix-webhooks/blob/main/python/README.md

Run the test suite. Note that integration tests require a running Docker/Podman/etc server and working docker-compose.

```sh
uv run pytest
```

--------------------------------

### Format code with php-cs-fixer

Source: https://github.com/svix/svix-webhooks/blob/main/php/README.md

Before opening a PR, format the code using php-cs-fixer with the provided command.

```sh
composer install
./vendor/bin/php-cs-fixer fix -v --using-cache=no .
```

--------------------------------

### Run tests

Source: https://github.com/svix/svix-webhooks/blob/main/ruby/README.md

Runs the test suite using RSpec.

```sh
bundle exec rspec spec
```

--------------------------------

### Build Svix Bridge with Docker

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Clones the svix-webhooks repository, changes to the bridge directory, and builds a Docker image tagged svix-bridge:local. This method avoids needing a local Rust toolchain.

```bash
# Clone the repository
git clone https://github.com/svix/svix-webhooks
# Change to the source directory
cd svix-webhooks/bridge/
# Build
docker build --tag svix-bridge:local .

```

--------------------------------

### Generate asymmetric key pair with svix-server

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Generate a new asymmetric key pair for testing. The output shows the secret key (prefixed with whsk_) and public key (prefixed with whpk_).

```bash
$ svix-server asymmetric-key generate

Secret key: whsk_6Xb/dCcHpPea21PS1N9VY/NZW723CEc77N4rJCubMbfVKIDij2HKpMKkioLlX0dRqSKJp4AJ6p9lMicMFs6Kvg==
Public key: whpk_1SiA4o9hyqTCpIqC5V9HUakiiaeACeqfZTInDBbOir4=
```

--------------------------------

### Generate Bash completion script

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Use this command to generate a completion script for the bash shell.

```sh
svix completion bash
```

--------------------------------

### Configure transformation with format string

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Uses the verbose form with format 'string' to receive the raw payload. The handler can parse the input using any method, such as DOMParser for XML.

```yaml
transformation:
  # Let's say the input is an XML message like:
  # `<msg appId="app_123" eventType="a.b"><payload>{"x": 123}</payload></msg>`

  format: "string"
  src: |
    function handler(input) {
      let parser = new DOMParser();
      let doc = parser.parseFromString(input, "text/xml");
      let msg = doc.firstChild;
      let payload = JSON.parse(msg.getElementsByTagName("payload")[0].textContent)

      return {
        appId: msg.attributes.appId,
        message: {
          eventType: msg.attributes.eventType,
          payload,
        }
      };
    }

```

--------------------------------

### Source Bash completion automatically

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Add this command to your shell rc file to automatically source the completion script.

```sh
eval "$(svix completion bash)"
```

--------------------------------

### Run Svix CLI executable manually

Source: https://github.com/svix/svix-webhooks/blob/main/svix-cli/README.md

Run the Svix CLI executable after downloading and extracting the archive for your operating system. You may need to allow execution by running chmod +x svix.

```sh
./svix help
```

--------------------------------

### Create endpoint for operational webhooks

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Adds an endpoint to receive operational webhooks. The app_id is the org ID of the default account, and the filterTypes restrict which events are sent.

```bash
curl -X 'POST' \
  'https://api.eu.svix.com/api/v1/app/org_23rb8YdGqMT0qIzpgGwdXfHirMu/endpoint/' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
        "url": "https://operational-webhook-destination.com/webhook/",
        "filterTypes": [
          "endpoint.updated",
          "endpoint.deleted"
        ],
    }'
```

--------------------------------

### Enable rustls-tls feature in Cargo.toml

Source: https://github.com/svix/svix-webhooks/blob/main/rust/README.md

Add the svix crate with the rustls-tls feature to use rustls instead of the default rust-native-tls. This disables default features, so you must explicitly enable any other features you need.

```toml
svix = { version = "N", features = ["rustls-tls"], default-features = false  }
```

--------------------------------

### Add Gradle Dependency

Source: https://github.com/svix/svix-webhooks/blob/main/kotlin/README.md

Include the svix-kotlin dependency in your project's build file.

```groovy
implementation "com.svix.kotlin:svix-kotlin:2.7.0"
```

--------------------------------

### Configure transformation as a single string

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Configures a transformation as a single string of JavaScript source code. The input value is pre-parsed as JSON by default.

```yaml
transformation: |
    function handler(input) {
      return {
        appId: input.key,
        message: {
          eventType: input.event_type,
          payload: input.data
        }
      };
    }

```

--------------------------------

### Pull Svix Bridge Docker image

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Pulls the Svix Bridge Docker image from Docker Hub.

```bash
$ docker pull svix/svix-bridge

```

--------------------------------

### Format code with yarn lint:fix

Source: https://github.com/svix/svix-webhooks/blob/main/javascript/README.md

Run the linter with auto-fix to format code before opening a pull request.

```sh
yarn lint:fix
```

--------------------------------

### Configure transformation with verbose format json

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Uses the verbose form to set the transformation format to 'json' (the default behavior). The handler function receives a JSON-parsed input.

```yaml
transformation:
  format: "json"
  src: |
    function handler(input) {
      return {
        appId: input.key,
        message: {
          eventType: input.event_type,
          payload: input.data
        }
      };
    }

```

--------------------------------

### Add Maven Dependency

Source: https://github.com/svix/svix-webhooks/blob/main/kotlin/README.md

Include the svix-kotlin dependency in your project's POM file.

```xml
<dependency>
  <groupId>com.svix.kotlin</groupId>
  <artifactId>svix-kotlin</artifactId>
  <version>2.7.0</version>
  <scope>compile</scope>
</dependency>
```

--------------------------------

### Authentication header with Bearer JWT

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Use this header to authenticate requests to the svix-server. Replace <JWT_TOKEN_HERE> with a valid JWT generated with the correct secret.

```text
Authorization: Bearer <JWT_TOKEN_HERE>
```

--------------------------------

### Generate JWT with svix-server jwt generate

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Generates a JWT for the default organization. The generated token can be used as a Bearer token for authentication.

```bash
svix-server jwt generate
```

--------------------------------

### Add gem to Gemfile

Source: https://github.com/svix/svix-webhooks/blob/main/ruby/README.md

Adds the svix gem to a Ruby application's Gemfile for dependency management.

```ruby
gem 'svix'
```

--------------------------------

### Gradle dependency for Svix Java library

Source: https://github.com/svix/svix-webhooks/blob/main/java/README.md

Add this dependency to your project's build file to use the Svix Java library version 2.7.0.

```groovy
implementation "com.svix:svix:2.7.0"
```

--------------------------------

### Generate JWT for operational webhooks service account

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Generates a JWT for the operational webhooks service account. This token is different from the normal JWT and is used to access the operational webhooks account.

```bash
svix-server jwt generate org_00000000000SvixManagement00
```

--------------------------------

### Maven dependency for Svix Java library

Source: https://github.com/svix/svix-webhooks/blob/main/java/README.md

Add this dependency to your project's POM to use the Svix Java library version 2.7.0.

```xml
<dependency>
  <groupId>com.svix</groupId>
  <artifactId>svix</artifactId>
  <version>2.7.0</version>
  <scope>compile</scope>
</dependency>
```

--------------------------------

### Configure default_signature_type to ed25519

Source: https://github.com/svix/svix-webhooks/blob/main/README.md

Set the default signature type for endpoints to ed25519 asymmetric signatures. This overrides the default symmetric secret generation.

```toml
default_signature_type = "ed25519"
```

--------------------------------

### Expected sender JSON shape

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Expected JSON shape for senders. The message field follows the Svix message creation API.

```json
{
    "appId": "app_XYZ",
    "message": {
        "eventType": "my.event",
        "payload": {"code": 123, "message": "something happened..."}
    }
}
```

--------------------------------

### Required receiver output JSON shape

Source: https://github.com/svix/svix-webhooks/blob/main/bridge/README.md

Required output JSON shape for receivers: a JSON object with a payload field representing the message to publish.

```json
{
    "payload": {"msg": "my cool message, published by svix-bridge!"}
}
```
Tokens:
Raw