Can I use Svix as a CLI?

Yes. KosmoKrator exposes a Svix CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Svix through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Svix tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Svix credentials stored?

Svix credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Svix MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

developer

Svix CLI for AI Agents

Use the Svix CLI from KosmoKrator to call Svix tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 5 read 2 write API token auth

Submit Svix feedback View package source

Svix CLI Setup

Svix can be configured headlessly with `kosmokrator integrations:configure svix`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure svix --set auth_token="$SVIX_AUTH_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor svix --json
kosmokrator integrations:status --json

Credentials

Authentication type: API token api_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`auth_token`	`SVIX_AUTH_TOKEN`	Secret `secret`	yes	Auth Token
`url`	`SVIX_URL`	URL `url`	no	API Base URL

Call Svix Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call svix.svix_list_applications '{
  "limit": 1,
  "iterator": "example_iterator"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:svix svix_list_applications '{
  "limit": 1,
  "iterator": "example_iterator"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs svix --json
kosmo integrations:docs svix.svix_list_applications --json
kosmo integrations:schema svix.svix_list_applications --json
kosmo integrations:search "Svix" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Svix.

`svix.svix_list_applications`

Read read

List all Svix applications. Returns application IDs, names, and UIDs that you can use to manage endpoints and messages.

Parameters: limit, iterator

Generic CLI call

kosmo integrations:call svix.svix_list_applications '{"limit":1,"iterator":"example_iterator"}' --json

Provider shortcut

kosmo integrations:svix svix_list_applications '{"limit":1,"iterator":"example_iterator"}' --json

`svix.svix_get_application`

Read read

Get details of a specific Svix application by its ID, including name, UID, and created timestamp.

Parameters: id

Generic CLI call

kosmo integrations:call svix.svix_get_application '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:svix svix_get_application '{"id":"example_id"}' --json

`svix.svix_create_application`

Write write

Create a new Svix application. Each application represents a webhook sender with its own set of endpoints.

Parameters: name, uid

Generic CLI call

kosmo integrations:call svix.svix_create_application '{"name":"example_name","uid":"example_uid"}' --json

Provider shortcut

kosmo integrations:svix svix_create_application '{"name":"example_name","uid":"example_uid"}' --json

`svix.svix_list_messages`

Read read

List messages for a Svix application. Returns message IDs, event types, payloads, and delivery status.

Parameters: app_id, limit, iterator

Generic CLI call

kosmo integrations:call svix.svix_list_messages '{"app_id":"example_app_id","limit":1,"iterator":"example_iterator"}' --json

Provider shortcut

kosmo integrations:svix svix_list_messages '{"app_id":"example_app_id","limit":1,"iterator":"example_iterator"}' --json

`svix.svix_list_endpoints`

Read read

List webhook endpoints for a Svix application. Returns endpoint IDs, URLs, and descriptions.

Parameters: app_id, limit, iterator

Generic CLI call

kosmo integrations:call svix.svix_list_endpoints '{"app_id":"example_app_id","limit":1,"iterator":"example_iterator"}' --json

Provider shortcut

kosmo integrations:svix svix_list_endpoints '{"app_id":"example_app_id","limit":1,"iterator":"example_iterator"}' --json

`svix.svix_create_endpoint`

Write write

Create a new webhook endpoint for a Svix application. Webhook events will be delivered to the specified URL.

Parameters: app_id, url, version, description

Generic CLI call

kosmo integrations:call svix.svix_create_endpoint '{"app_id":"example_app_id","url":"example_url","version":1,"description":"example_description"}' --json

Provider shortcut

kosmo integrations:svix svix_create_endpoint '{"app_id":"example_app_id","url":"example_url","version":1,"description":"example_description"}' --json

`svix.svix_get_current_user`

Read read

Get the current authenticated Svix user and dashboard usage information.

Parameters: none

Generic CLI call

kosmo integrations:call svix.svix_get_current_user '{}' --json

Provider shortcut

kosmo integrations:svix svix_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`svix.svix_list_applications`

List all Svix applications. Returns application IDs, names, and UIDs that you can use to manage endpoints and messages.

Operation: Read read
Schema command: kosmo integrations:schema svix.svix_list_applications --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of applications to return (default: 50, max: 250).
`iterator`	string	no	Cursor for pagination — pass the iterator value from a previous response to get the next page.

`svix.svix_get_application`

Get details of a specific Svix application by its ID, including name, UID, and created timestamp.

Operation: Read read
Schema command: kosmo integrations:schema svix.svix_get_application --json

Parameter	Type	Required	Description
`id`	string	yes	The application ID (e.g., "app_xxxxxxxxx").

`svix.svix_create_application`

Create a new Svix application. Each application represents a webhook sender with its own set of endpoints.

Operation: Write write
Schema command: kosmo integrations:schema svix.svix_create_application --json

Parameter	Type	Required	Description
`name`	string	yes	The application name (e.g., "My App").
`uid`	string	no	Optional unique identifier for the application. Must be unique across all applications.

`svix.svix_list_messages`

List messages for a Svix application. Returns message IDs, event types, payloads, and delivery status.

Operation: Read read
Schema command: kosmo integrations:schema svix.svix_list_messages --json

Parameter	Type	Required	Description
`app_id`	string	yes	The application ID (e.g., "app_xxxxxxxxx").
`limit`	integer	no	Maximum number of messages to return (default: 50, max: 250).
`iterator`	string	no	Cursor for pagination — pass the iterator value from a previous response to get the next page.

`svix.svix_list_endpoints`

List webhook endpoints for a Svix application. Returns endpoint IDs, URLs, and descriptions.

Operation: Read read
Schema command: kosmo integrations:schema svix.svix_list_endpoints --json

Parameter	Type	Required	Description
`app_id`	string	yes	The application ID (e.g., "app_xxxxxxxxx").
`limit`	integer	no	Maximum number of endpoints to return (default: 50, max: 250).
`iterator`	string	no	Cursor for pagination — pass the iterator value from a previous response to get the next page.

`svix.svix_create_endpoint`

Create a new webhook endpoint for a Svix application. Webhook events will be delivered to the specified URL.

Operation: Write write
Schema command: kosmo integrations:schema svix.svix_create_endpoint --json

Parameter	Type	Required	Description
`app_id`	string	yes	The application ID (e.g., "app_xxxxxxxxx").
`url`	string	yes	The URL where webhook events will be delivered (e.g., "https://example.com/webhooks").
`version`	integer	yes	The API version for the endpoint (e.g., 1).
`description`	string	no	Optional description for the endpoint.

`svix.svix_get_current_user`

Get the current authenticated Svix user and dashboard usage information.

Operation: Read read
Schema command: kosmo integrations:schema svix.svix_get_current_user --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.