developer
Svix CLI for CI
Use the Svix CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 5 read 2 write API token auth
Svix CLI for CI
Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.
Use this shape when a pipeline needs to read or update an external service. The Svix CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Svix CLI for CI
kosmokrator integrations:configure svix --set auth_token="$SVIX_AUTH_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call svix.svix_list_applications '{"limit":1,"iterator":"example_iterator"}' --json Discovery Before Execution
Agents and scripts can inspect Svix docs and schemas 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 Useful Svix CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
svix.svix_list_applications | Read | limit, iterator | List all Svix applications. Returns application IDs, names, and UIDs that you can use to manage endpoints and messages. |
svix.svix_get_application | Read | id | Get details of a specific Svix application by its ID, including name, UID, and created timestamp. |
svix.svix_create_application | Write | name, uid | Create a new Svix application. Each application represents a webhook sender with its own set of endpoints. |
svix.svix_list_messages | Read | app_id, limit, iterator | List messages for a Svix application. Returns message IDs, event types, payloads, and delivery status. |
svix.svix_list_endpoints | Read | app_id, limit, iterator | List webhook endpoints for a Svix application. Returns endpoint IDs, URLs, and descriptions. |
svix.svix_create_endpoint | Write | app_id, url, version, description | Create a new webhook endpoint for a Svix application. Webhook events will be delivered to the specified URL. |
svix.svix_get_current_user | Read | none | Get the current authenticated Svix user and dashboard usage information. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.