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.

productivity

Svix Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Svix KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.svix.*. Use lua_read_doc("integrations.svix") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Svix workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.svix.aggregate_app_stats({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("svix"))' --json
kosmo integrations:lua --eval 'print(docs.read("svix.aggregate_app_stats"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local svix = app.integrations.svix
local result = svix.aggregate_app_stats({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.svix, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.svix.default.* or app.integrations.svix.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Svix, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Svix

Namespace: app.integrations.svix

Svix tools use the official Svix REST API. Configure auth_token; set url only for self-hosted Svix or a test proxy. Tool names follow the API operation names where possible, and each tool description includes the official HTTP endpoint and operation id.

Common Webhook Operations

local apps = app.integrations.svix.list_applications({
  limit = 10
})

local app = app.integrations.svix.create_application({
  get_if_exists = true,
  payload = {
    name = "Example tenant",
    uid = "tenant_123"
  }
})

local endpoint = app.integrations.svix.create_endpoint({
  app_id = app.id,
  idempotency_key = "setup-tenant-123-endpoint",
  payload = {
    url = "https://example.test/webhooks/svix",
    version = 1,
    description = "Primary receiver",
    filterTypes = { "user.created", "user.deleted" }
  }
})

local message = app.integrations.svix.create_message({
  app_id = app.id,
  idempotency_key = "msg-user-123-created",
  payload = {
    eventType = "user.created",
    payload = {
      id = "user_123",
      email = "user@example.test"
    }
  }
})

Event Types

local event_types = app.integrations.svix.list_event_types({
  limit = 50,
  include_archived = false
})

local event_type = app.integrations.svix.create_event_type({
  payload = {
    name = "invoice.paid",
    description = "An invoice was paid"
  }
})

Delivery Inspection And Replay

local messages = app.integrations.svix.list_messages({
  app_id = "app_123",
  limit = 25,
  with_content = true
})

local attempts = app.integrations.svix.list_attempts_by_msg({
  app_id = "app_123",
  msg_id = "msg_123"
})

local replay = app.integrations.svix.resend_webhook({
  app_id = "app_123",
  msg_id = "msg_123",
  endpoint_id = "ep_123",
  idempotency_key = "replay-msg-123-ep-123"
})

Streams And Ingest

The integration also exposes Svix Streams and Ingest APIs:

local stream = app.integrations.svix.create_stream({
  payload = {
    name = "Audit stream",
    uid = "audit"
  }
})

local sink = app.integrations.svix.create_sink({
  stream_id = stream.id,
  payload = {
    name = "Warehouse",
    type = "webhook",
    config = {
      url = "https://example.test/ingest"
    }
  }
})

local source = app.integrations.svix.create_ingest_source({
  payload = {
    name = "Inbound partner",
    uid = "partner_123"
  }
})

Argument Shape

Path and query parameters are top-level snake_case arguments. Header parameters are also top-level snake_case arguments, so the Svix idempotency-key header is idempotency_key.

Write operations accept a payload object for the JSON body. Tools also accept:

query: extra documented query parameters
headers: extra HTTP headers

Responses are the parsed Svix JSON response. Empty responses return { success = true, status = 204 }.

Multi-Account Usage

app.integrations.svix.list_applications({ limit = 10 })
app.integrations.svix.default.list_applications({ limit = 10 })
app.integrations.svix.production.list_applications({ limit = 10 })

All account namespaces expose the same tool names. Only the credentials differ.

Raw agent markdown

# Svix

Namespace: `app.integrations.svix`

Svix tools use the official Svix REST API. Configure `auth_token`; set `url`
only for self-hosted Svix or a test proxy. Tool names follow the API operation
names where possible, and each tool description includes the official HTTP
endpoint and operation id.

## Common Webhook Operations

```lua
local apps = app.integrations.svix.list_applications({
  limit = 10
})

local app = app.integrations.svix.create_application({
  get_if_exists = true,
  payload = {
    name = "Example tenant",
    uid = "tenant_123"
  }
})

local endpoint = app.integrations.svix.create_endpoint({
  app_id = app.id,
  idempotency_key = "setup-tenant-123-endpoint",
  payload = {
    url = "https://example.test/webhooks/svix",
    version = 1,
    description = "Primary receiver",
    filterTypes = { "user.created", "user.deleted" }
  }
})

local message = app.integrations.svix.create_message({
  app_id = app.id,
  idempotency_key = "msg-user-123-created",
  payload = {
    eventType = "user.created",
    payload = {
      id = "user_123",
      email = "user@example.test"
    }
  }
})
```

## Event Types

```lua
local event_types = app.integrations.svix.list_event_types({
  limit = 50,
  include_archived = false
})

local event_type = app.integrations.svix.create_event_type({
  payload = {
    name = "invoice.paid",
    description = "An invoice was paid"
  }
})
```

## Delivery Inspection And Replay

```lua
local messages = app.integrations.svix.list_messages({
  app_id = "app_123",
  limit = 25,
  with_content = true
})

local attempts = app.integrations.svix.list_attempts_by_msg({
  app_id = "app_123",
  msg_id = "msg_123"
})

local replay = app.integrations.svix.resend_webhook({
  app_id = "app_123",
  msg_id = "msg_123",
  endpoint_id = "ep_123",
  idempotency_key = "replay-msg-123-ep-123"
})
```

## Streams And Ingest

The integration also exposes Svix Streams and Ingest APIs:

```lua
local stream = app.integrations.svix.create_stream({
  payload = {
    name = "Audit stream",
    uid = "audit"
  }
})

local sink = app.integrations.svix.create_sink({
  stream_id = stream.id,
  payload = {
    name = "Warehouse",
    type = "webhook",
    config = {
      url = "https://example.test/ingest"
    }
  }
})

local source = app.integrations.svix.create_ingest_source({
  payload = {
    name = "Inbound partner",
    uid = "partner_123"
  }
})
```

## Argument Shape

Path and query parameters are top-level snake_case arguments. Header parameters
are also top-level snake_case arguments, so the Svix `idempotency-key` header is
`idempotency_key`.

Write operations accept a `payload` object for the JSON body. Tools also accept:

- `query`: extra documented query parameters
- `headers`: extra HTTP headers

Responses are the parsed Svix JSON response. Empty responses return
`{ success = true, status = 204 }`.

## Multi-Account Usage

```lua
app.integrations.svix.list_applications({ limit = 10 })
app.integrations.svix.default.list_applications({ limit = 10 })
app.integrations.svix.production.list_applications({ limit = 10 })
```

All account namespaces expose the same tool names. Only the credentials differ.

Metadata-derived Lua example

local result = app.integrations.svix.aggregate_app_stats({})
print(result)

Functions

aggregate_app_stats Write

Creates a background task to calculate the number of message attempts (`messageDestinations`) made for all applications in the environment. Official Svix API endpoint: POST https://api.svix.com/api/v1/stats/usage/app (operationId: v1.statistics.aggregate-app-stats).

Lua path: app.integrations.svix.aggregate_app_stats
Full name: svix.svix_aggregate_app_stats

Parameter	Type	Required	Description
No parameters.

aggregate_event_types Write

Creates a background task to calculate the listed event types for all apps in the organization. Official Svix API endpoint: PUT https://api.svix.com/api/v1/stats/usage/event-types (operationId: v1.statistics.aggregate-event-types).

Lua path: app.integrations.svix.aggregate_event_types
Full name: svix.svix_aggregate_event_types

Parameter	Type	Required	Description
No parameters.

bulk_replay_messages Write

Bulk replay messages sent to the endpoint. Only messages that were created after `since` will be sent. This will replay both successful, and failed messages A completed task will return a payload like the following: Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay (operationId: v1.endpoint.bulk-replay).

Lua path: app.integrations.svix.bulk_replay_messages
Full name: svix.svix_bulk_replay_messages

Parameter	Type	Required	Description
No parameters.

create_application Write

Create a new application. Official Svix API endpoint: POST https://api.svix.com/api/v1/app (operationId: v1.application.create).

Lua path: app.integrations.svix.create_application
Full name: svix.svix_create_application

Parameter	Type	Required	Description
No parameters.

create_connector Write

Create a new connector. Official Svix API endpoint: POST https://api.svix.com/api/v1/connector (operationId: v1.connector.create).

Lua path: app.integrations.svix.create_connector
Full name: svix.svix_create_connector

Parameter	Type	Required	Description
No parameters.

create_endpoint Write

Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended). Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/endpoint (operationId: v1.endpoint.create).

Lua path: app.integrations.svix.create_endpoint
Full name: svix.svix_create_endpoint

Parameter	Type	Required	Description
No parameters.

create_event_type Write

Create new or unarchive existing event type. Official Svix API endpoint: POST https://api.svix.com/api/v1/event-type (operationId: v1.event-type.create).

Lua path: app.integrations.svix.create_event_type
Full name: svix.svix_create_event_type

Parameter	Type	Required	Description
No parameters.

create_events Write

Creates events on the Stream. Official Svix API endpoint: POST https://api.svix.com/api/v1/stream/{stream_id}/events (operationId: v1.streaming.events.create).

Lua path: app.integrations.svix.create_events
Full name: svix.svix_create_events

Parameter	Type	Required	Description
No parameters.

create_ingest_endpoint Write

Create an ingest endpoint. Official Svix API endpoint: POST https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint (operationId: v1.ingest.endpoint.create).

Lua path: app.integrations.svix.create_ingest_endpoint
Full name: svix.svix_create_ingest_endpoint

Parameter	Type	Required	Description
No parameters.

create_ingest_source Write

Create Ingest Source. Official Svix API endpoint: POST https://api.svix.com/ingest/api/v1/source (operationId: v1.ingest.source.create).

Lua path: app.integrations.svix.create_ingest_source
Full name: svix.svix_create_ingest_source

Parameter	Type	Required	Description
No parameters.

create_integration Write

Create an integration. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/integration (operationId: v1.integration.create).

Lua path: app.integrations.svix.create_integration
Full name: svix.svix_create_integration

Parameter	Type	Required	Description
No parameters.

create_message Write

Creates a new message and dispatches it to all of the application's endpoints. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/msg (operationId: v1.message.create).

Lua path: app.integrations.svix.create_message
Full name: svix.svix_create_message

Parameter	Type	Required	Description
No parameters.

create_message_precheck Write

A pre-check call for `message.create` that checks whether any active endpoints are listening to this message. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/msg/precheck/active (operationId: v1.message.precheck).

Lua path: app.integrations.svix.create_message_precheck
Full name: svix.svix_create_message_precheck

Parameter	Type	Required	Description
No parameters.

create_operational_webhook_endpoint Write

Create an operational webhook endpoint. Official Svix API endpoint: POST https://api.svix.com/api/v1/operational-webhook/endpoint (operationId: v1.operational-webhook.endpoint.create).

Lua path: app.integrations.svix.create_operational_webhook_endpoint
Full name: svix.svix_create_operational_webhook_endpoint

Parameter	Type	Required	Description
No parameters.

create_sink Write

Creates a new sink. Official Svix API endpoint: POST https://api.svix.com/api/v1/stream/{stream_id}/sink (operationId: v1.streaming.sink.create).

Lua path: app.integrations.svix.create_sink
Full name: svix.svix_create_sink

Parameter	Type	Required	Description
No parameters.

create_stream Write

Creates a new stream. Official Svix API endpoint: POST https://api.svix.com/api/v1/stream (operationId: v1.streaming.stream.create).

Lua path: app.integrations.svix.create_stream
Full name: svix.svix_create_stream

Parameter	Type	Required	Description
No parameters.

create_stream_event_type Write

Create an event type for Streams. Official Svix API endpoint: POST https://api.svix.com/api/v1/stream/event-type (operationId: v1.streaming.event-type.create).

Lua path: app.integrations.svix.create_stream_event_type
Full name: svix.svix_create_stream_event_type

Parameter	Type	Required	Description
No parameters.

delete_application Write

Delete an application. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/app/{app_id} (operationId: v1.application.delete).

Lua path: app.integrations.svix.delete_application
Full name: svix.svix_delete_application

Parameter	Type	Required	Description
No parameters.

delete_attempt_response_body Write

Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content. The message can't be replayed or resent once its payload has been deleted or expired. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/content (operationId: v1.message-attempt.expunge-content).

Lua path: app.integrations.svix.delete_attempt_response_body
Full name: svix.svix_delete_attempt_response_body

Parameter	Type	Required	Description
No parameters.

delete_connector Write

Delete a connector. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/connector/{connector_id} (operationId: v1.connector.delete).

Lua path: app.integrations.svix.delete_connector
Full name: svix.svix_delete_connector

Parameter	Type	Required	Description
No parameters.

delete_endpoint Write

Delete an endpoint. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id} (operationId: v1.endpoint.delete).

Lua path: app.integrations.svix.delete_endpoint
Full name: svix.svix_delete_endpoint

Parameter	Type	Required	Description
No parameters.

delete_event_type Write

Archive an event type. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/event-type/{event_type_name} (operationId: v1.event-type.delete).

Lua path: app.integrations.svix.delete_event_type
Full name: svix.svix_delete_event_type

Parameter	Type	Required	Description
No parameters.

delete_ingest_endpoint Write

Delete an ingest endpoint. Official Svix API endpoint: DELETE https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id} (operationId: v1.ingest.endpoint.delete).

Lua path: app.integrations.svix.delete_ingest_endpoint
Full name: svix.svix_delete_ingest_endpoint

Parameter	Type	Required	Description
No parameters.

delete_ingest_source Write

Delete an Ingest Source. Official Svix API endpoint: DELETE https://api.svix.com/ingest/api/v1/source/{source_id} (operationId: v1.ingest.source.delete).

Lua path: app.integrations.svix.delete_ingest_source
Full name: svix.svix_delete_ingest_source

Parameter	Type	Required	Description
No parameters.

delete_integration Write

Delete an integration. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/app/{app_id}/integration/{integ_id} (operationId: v1.integration.delete).

Lua path: app.integrations.svix.delete_integration
Full name: svix.svix_delete_integration

Parameter	Type	Required	Description
No parameters.

delete_message_payload Write

Delete the given message's payload. Useful in cases when a message was accidentally sent with sensitive content. The message can't be replayed or resent once its payload has been deleted or expired. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/app/{app_id}/msg/{msg_id}/content (operationId: v1.message.expunge-content).

Lua path: app.integrations.svix.delete_message_payload
Full name: svix.svix_delete_message_payload

Parameter	Type	Required	Description
No parameters.

delete_operational_webhook_endpoint Write

Delete an operational webhook endpoint. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id} (operationId: v1.operational-webhook.endpoint.delete).

Lua path: app.integrations.svix.delete_operational_webhook_endpoint
Full name: svix.svix_delete_operational_webhook_endpoint

Parameter	Type	Required	Description
No parameters.

delete_sink Write

Delete a sink. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id} (operationId: v1.streaming.sink.delete).

Lua path: app.integrations.svix.delete_sink
Full name: svix.svix_delete_sink

Parameter	Type	Required	Description
No parameters.

delete_stream Write

Delete a stream. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/stream/{stream_id} (operationId: v1.streaming.stream.delete).

Lua path: app.integrations.svix.delete_stream
Full name: svix.svix_delete_stream

Parameter	Type	Required	Description
No parameters.

delete_stream_event_type Write

Delete an event type. Official Svix API endpoint: DELETE https://api.svix.com/api/v1/stream/event-type/{name} (operationId: v1.streaming.event-type.delete).

Lua path: app.integrations.svix.delete_stream_event_type
Full name: svix.svix_delete_stream_event_type

Parameter	Type	Required	Description
No parameters.

endpoint_stats Read

Get basic statistics for the endpoint. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/stats (operationId: v1.endpoint.get-stats).

Lua path: app.integrations.svix.endpoint_stats
Full name: svix.svix_endpoint_stats

Parameter	Type	Required	Description
No parameters.

event_type_import_from_openapi Write

Given an OpenAPI spec, create new or update existing event types. Official Svix API endpoint: POST https://api.svix.com/api/v1/event-type/import/openapi (operationId: v1.event-type.import-openapi).

Lua path: app.integrations.svix.event_type_import_from_openapi
Full name: svix.svix_event_type_import_from_openapi

Parameter	Type	Required	Description
No parameters.

expire_all Write

Expire all of the tokens associated with a specific application. Official Svix API endpoint: POST https://api.svix.com/api/v1/auth/app/{app_id}/expire-all (operationId: v1.authentication.expire-all).

Lua path: app.integrations.svix.expire_all
Full name: svix.svix_expire_all

Parameter	Type	Required	Description
No parameters.

export_environment_configuration Write

Download a JSON file containing all org-settings and event types. Note that the schema for [`EnvironmentOut`] is subject to change. The fields herein are provided for convenience but should be treated as JSON blobs. Official Svix API endpoint: POST https://api.svix.com/api/v1/environment/export (operationId: v1.environment.export).

Lua path: app.integrations.svix.export_environment_configuration
Full name: svix.svix_export_environment_configuration

Parameter	Type	Required	Description
No parameters.

expunge_all_message_contents Write

Delete all message payloads for the application. This operation is only available in the Enterprise plan. A completed task will return a payload like the following: Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/msg/expunge-all-contents (operationId: v1.message.expunge-all-contents).

Lua path: app.integrations.svix.expunge_all_message_contents
Full name: svix.svix_expunge_all_message_contents

Parameter	Type	Required	Description
No parameters.

get_application Read

Get an application. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id} (operationId: v1.application.get).

Lua path: app.integrations.svix.get_application
Full name: svix.svix_get_application

Parameter	Type	Required	Description
No parameters.

get_attempt Read

`msg_id`: Use a message id or a message `eventId` Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id} (operationId: v1.message-attempt.get).

Lua path: app.integrations.svix.get_attempt
Full name: svix.svix_get_attempt

Parameter	Type	Required	Description
No parameters.

get_background_task Read

Get a background task by ID. Official Svix API endpoint: GET https://api.svix.com/api/v1/background-task/{task_id} (operationId: v1.background-task.get).

Lua path: app.integrations.svix.get_background_task
Full name: svix.svix_get_background_task

Parameter	Type	Required	Description
No parameters.

get_connector Read

Get a connector. Official Svix API endpoint: GET https://api.svix.com/api/v1/connector/{connector_id} (operationId: v1.connector.get).

Lua path: app.integrations.svix.get_connector
Full name: svix.svix_get_connector

Parameter	Type	Required	Description
No parameters.

get_consumer_app_portal_access Write

Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal. Official Svix API endpoint: POST https://api.svix.com/api/v1/auth/app-portal-access/{app_id} (operationId: v1.authentication.app-portal-access).

Lua path: app.integrations.svix.get_consumer_app_portal_access
Full name: svix.svix_get_consumer_app_portal_access

Parameter	Type	Required	Description
No parameters.

get_endpoint Read

Get an endpoint. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id} (operationId: v1.endpoint.get).

Lua path: app.integrations.svix.get_endpoint
Full name: svix.svix_get_endpoint

Parameter	Type	Required	Description
No parameters.

get_endpoint_headers Read

Get the additional headers to be sent with the webhook. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers (operationId: v1.endpoint.get-headers).

Lua path: app.integrations.svix.get_endpoint_headers
Full name: svix.svix_get_endpoint_headers

Parameter	Type	Required	Description
No parameters.

get_endpoint_secret Read

Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/). Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret (operationId: v1.endpoint.get-secret).

Lua path: app.integrations.svix.get_endpoint_secret
Full name: svix.svix_get_endpoint_secret

Parameter	Type	Required	Description
No parameters.

get_endpoint_transformation Read

Get the transformation code associated with this endpoint. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation (operationId: v1.endpoint.transformation-get).

Lua path: app.integrations.svix.get_endpoint_transformation
Full name: svix.svix_get_endpoint_transformation

Parameter	Type	Required	Description
No parameters.

get_event_type Read

Get an event type. Official Svix API endpoint: GET https://api.svix.com/api/v1/event-type/{event_type_name} (operationId: v1.event-type.get).

Lua path: app.integrations.svix.get_event_type
Full name: svix.svix_get_event_type

Parameter	Type	Required	Description
No parameters.

get_ingest_endpoint Read

Get an ingest endpoint. Official Svix API endpoint: GET https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id} (operationId: v1.ingest.endpoint.get).

Lua path: app.integrations.svix.get_ingest_endpoint
Full name: svix.svix_get_ingest_endpoint

Parameter	Type	Required	Description
No parameters.

get_ingest_endpoint_headers Read

Get the additional headers to be sent with the ingest. Official Svix API endpoint: GET https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/headers (operationId: v1.ingest.endpoint.get-headers).

Lua path: app.integrations.svix.get_ingest_endpoint_headers
Full name: svix.svix_get_ingest_endpoint_headers

Parameter	Type	Required	Description
No parameters.

get_ingest_endpoint_secret Read

Get an ingest endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/). Official Svix API endpoint: GET https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret (operationId: v1.ingest.endpoint.get-secret).

Lua path: app.integrations.svix.get_ingest_endpoint_secret
Full name: svix.svix_get_ingest_endpoint_secret

Parameter	Type	Required	Description
No parameters.

get_ingest_endpoint_transformation Read

Get the transformation code associated with this ingest endpoint. Official Svix API endpoint: GET https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/transformation (operationId: v1.ingest.endpoint.get-transformation).

Lua path: app.integrations.svix.get_ingest_endpoint_transformation
Full name: svix.svix_get_ingest_endpoint_transformation

Parameter	Type	Required	Description
No parameters.

get_ingest_source Read

Get an Ingest Source by id or uid. Official Svix API endpoint: GET https://api.svix.com/ingest/api/v1/source/{source_id} (operationId: v1.ingest.source.get).

Lua path: app.integrations.svix.get_ingest_source
Full name: svix.svix_get_ingest_source

Parameter	Type	Required	Description
No parameters.

get_integration Read

Get an integration. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/integration/{integ_id} (operationId: v1.integration.get).

Lua path: app.integrations.svix.get_integration
Full name: svix.svix_get_integration

Parameter	Type	Required	Description
No parameters.

get_integration_key Read

Get an integration's key. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/integration/{integ_id}/key (operationId: v1.integration.get-key).

Lua path: app.integrations.svix.get_integration_key
Full name: svix.svix_get_integration_key

Parameter	Type	Required	Description
No parameters.

get_message Read

Get a message by its ID or eventID. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/msg/{msg_id} (operationId: v1.message.get).

Lua path: app.integrations.svix.get_message
Full name: svix.svix_get_message

Parameter	Type	Required	Description
No parameters.

get_operational_webhook_endpoint Read

Get an operational webhook endpoint. Official Svix API endpoint: GET https://api.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id} (operationId: v1.operational-webhook.endpoint.get).

Lua path: app.integrations.svix.get_operational_webhook_endpoint
Full name: svix.svix_get_operational_webhook_endpoint

Parameter	Type	Required	Description
No parameters.

get_operational_webhook_endpoint_headers Read

Get the additional headers to be sent with the operational webhook. Official Svix API endpoint: GET https://api.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id}/headers (operationId: v1.operational-webhook.endpoint.get-headers).

Lua path: app.integrations.svix.get_operational_webhook_endpoint_headers
Full name: svix.svix_get_operational_webhook_endpoint_headers

Parameter	Type	Required	Description
No parameters.

get_operational_webhook_endpoint_secret Read

Get an operational webhook endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/). Official Svix API endpoint: GET https://api.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id}/secret (operationId: v1.operational-webhook.endpoint.get-secret).

Lua path: app.integrations.svix.get_operational_webhook_endpoint_secret
Full name: svix.svix_get_operational_webhook_endpoint_secret

Parameter	Type	Required	Description
No parameters.

get_poller_token Read

Get the current auth token for the stream poller. Official Svix API endpoint: GET https://api.svix.com/api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token (operationId: v1.authentication.get-stream-poller-token).

Lua path: app.integrations.svix.get_poller_token
Full name: svix.svix_get_poller_token

Parameter	Type	Required	Description
No parameters.

get_sink Read

Get a sink by id or uid. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id} (operationId: v1.streaming.sink.get).

Lua path: app.integrations.svix.get_sink
Full name: svix.svix_get_sink

Parameter	Type	Required	Description
No parameters.

get_sink_headers Read

Get the HTTP sink headers. Only valid for `http` or `otelTracing` sinks. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/headers (operationId: v1.streaming.sink-headers-get).

Lua path: app.integrations.svix.get_sink_headers
Full name: svix.svix_get_sink_headers

Parameter	Type	Required	Description
No parameters.

get_sink_secret Read

Get the sink's signing secret (only supported for http sinks) This is used to verify the authenticity of the delivery. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/secret (operationId: v1.streaming.sink.get-secret).

Lua path: app.integrations.svix.get_sink_secret
Full name: svix.svix_get_sink_secret

Parameter	Type	Required	Description
No parameters.

get_sink_transformation Read

Get the transformation code associated with this sink. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/transformation (operationId: v1.streaming.sink-transformation-get).

Lua path: app.integrations.svix.get_sink_transformation
Full name: svix.svix_get_sink_transformation

Parameter	Type	Required	Description
No parameters.

get_stream Read

Get a stream by id or uid. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/{stream_id} (operationId: v1.streaming.stream.get).

Lua path: app.integrations.svix.get_stream
Full name: svix.svix_get_stream

Parameter	Type	Required	Description
No parameters.

get_stream_event_type Read

Get an event type. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/event-type/{name} (operationId: v1.streaming.event-type.get).

Lua path: app.integrations.svix.get_stream_event_type
Full name: svix.svix_get_stream_event_type

Parameter	Type	Required	Description
No parameters.

get_stream_portal_access Write

Use this function to get magic links (and authentication codes) for connecting your users to the Stream Consumer Portal. Official Svix API endpoint: POST https://api.svix.com/api/v1/auth/stream-portal-access/{stream_id} (operationId: v1.authentication.stream-portal-access).

Lua path: app.integrations.svix.get_stream_portal_access
Full name: svix.svix_get_stream_portal_access

Parameter	Type	Required	Description
No parameters.

health Read

Verify the API server is up and running. Official Svix API endpoint: GET https://api.svix.com/api/v1/health (operationId: v1.health.get).

Lua path: app.integrations.svix.health
Full name: svix.svix_health

Parameter	Type	Required	Description
No parameters.

import_environment_configuration Write

Import a configuration into the active organization. Official Svix API endpoint: POST https://api.svix.com/api/v1/environment/import (operationId: v1.environment.import).

Lua path: app.integrations.svix.import_environment_configuration
Full name: svix.svix_import_environment_configuration

Parameter	Type	Required	Description
No parameters.

ingest_source_consumer_portal Write

Get access to the Ingest Source Consumer Portal. Official Svix API endpoint: POST https://api.svix.com/ingest/api/v1/source/{source_id}/dashboard (operationId: v1.ingest.dashboard).

Lua path: app.integrations.svix.ingest_source_consumer_portal
Full name: svix.svix_ingest_source_consumer_portal

Parameter	Type	Required	Description
No parameters.

list_applications Read

List of all the organization's applications. Official Svix API endpoint: GET https://api.svix.com/api/v1/app (operationId: v1.application.list).

Lua path: app.integrations.svix.list_applications
Full name: svix.svix_list_applications

Parameter	Type	Required	Description
No parameters.

list_attempted_destinations Read

List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/msg/{msg_id}/endpoint (operationId: v1.message-attempt.list-attempted-destinations).

Lua path: app.integrations.svix.list_attempted_destinations
Full name: svix.svix_list_attempted_destinations

Parameter	Type	Required	Description
No parameters.

list_attempted_messages Read

List messages for a particular endpoint. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/msg (operationId: v1.message-attempt.list-attempted-messages).

Lua path: app.integrations.svix.list_attempted_messages
Full name: svix.svix_list_attempted_messages

Parameter	Type	Required	Description
No parameters.

list_attempts_by_endpoint Read

List attempts by endpoint id Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id} (operationId: v1.message-attempt.list-by-endpoint).

Lua path: app.integrations.svix.list_attempts_by_endpoint
Full name: svix.svix_list_attempts_by_endpoint

Parameter	Type	Required	Description
No parameters.

list_attempts_by_msg Read

List attempts by message ID. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/attempt/msg/{msg_id} (operationId: v1.message-attempt.list-by-msg).

Lua path: app.integrations.svix.list_attempts_by_msg
Full name: svix.svix_list_attempts_by_msg

Parameter	Type	Required	Description
No parameters.

list_background_tasks Read

List background tasks executed in the past 90 days. Official Svix API endpoint: GET https://api.svix.com/api/v1/background-task (operationId: v1.background-task.list).

Lua path: app.integrations.svix.list_background_tasks
Full name: svix.svix_list_background_tasks

Parameter	Type	Required	Description
No parameters.

list_connectors Read

List all connectors for an application. Official Svix API endpoint: GET https://api.svix.com/api/v1/connector (operationId: v1.connector.list).

Lua path: app.integrations.svix.list_connectors
Full name: svix.svix_list_connectors

Parameter	Type	Required	Description
No parameters.

list_endpoints Read

List the application's endpoints. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/endpoint (operationId: v1.endpoint.list).

Lua path: app.integrations.svix.list_endpoints
Full name: svix.svix_list_endpoints

Parameter	Type	Required	Description
No parameters.

list_event_types Read

Return the list of event types. Official Svix API endpoint: GET https://api.svix.com/api/v1/event-type (operationId: v1.event-type.list).

Lua path: app.integrations.svix.list_event_types
Full name: svix.svix_list_event_types

Parameter	Type	Required	Description
No parameters.

list_ingest_endpoints Read

List ingest endpoints. Official Svix API endpoint: GET https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint (operationId: v1.ingest.endpoint.list).

Lua path: app.integrations.svix.list_ingest_endpoints
Full name: svix.svix_list_ingest_endpoints

Parameter	Type	Required	Description
No parameters.

list_ingest_sources Read

List of all the organization's Ingest Sources. Official Svix API endpoint: GET https://api.svix.com/ingest/api/v1/source (operationId: v1.ingest.source.list).

Lua path: app.integrations.svix.list_ingest_sources
Full name: svix.svix_list_ingest_sources

Parameter	Type	Required	Description
No parameters.

list_integrations Read

List the application's integrations. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/integration (operationId: v1.integration.list).

Lua path: app.integrations.svix.list_integrations
Full name: svix.svix_list_integrations

Parameter	Type	Required	Description
No parameters.

list_messages Read

List all of the application's messages. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/msg (operationId: v1.message.list).

Lua path: app.integrations.svix.list_messages
Full name: svix.svix_list_messages

Parameter	Type	Required	Description
No parameters.

list_operational_webhook_endpoints Read

List operational webhook endpoints. Official Svix API endpoint: GET https://api.svix.com/api/v1/operational-webhook/endpoint (operationId: v1.operational-webhook.endpoint.list).

Lua path: app.integrations.svix.list_operational_webhook_endpoints
Full name: svix.svix_list_operational_webhook_endpoints

Parameter	Type	Required	Description
No parameters.

list_sinks Read

List of all the stream's sinks. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/{stream_id}/sink (operationId: v1.streaming.sink.list).

Lua path: app.integrations.svix.list_sinks
Full name: svix.svix_list_sinks

Parameter	Type	Required	Description
No parameters.

list_stream_event_types Read

List of all the organization's event types for streaming. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/event-type (operationId: v1.streaming.event-type.list).

Lua path: app.integrations.svix.list_stream_event_types
Full name: svix.svix_list_stream_event_types

Parameter	Type	Required	Description
No parameters.

list_streams Read

List of all the organization's streams. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream (operationId: v1.streaming.stream.list).

Lua path: app.integrations.svix.list_streams
Full name: svix.svix_list_streams

Parameter	Type	Required	Description
No parameters.

logout Write

Logout an app token. Trying to log out other tokens will fail. Official Svix API endpoint: POST https://api.svix.com/api/v1/auth/logout (operationId: v1.authentication.logout).

Lua path: app.integrations.svix.logout
Full name: svix.svix_logout

Parameter	Type	Required	Description
No parameters.

patch_application Write

Partially update an application. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/app/{app_id} (operationId: v1.application.patch).

Lua path: app.integrations.svix.patch_application
Full name: svix.svix_patch_application

Parameter	Type	Required	Description
No parameters.

patch_connector Write

Partially update a connector. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/connector/{connector_id} (operationId: v1.connector.patch).

Lua path: app.integrations.svix.patch_connector
Full name: svix.svix_patch_connector

Parameter	Type	Required	Description
No parameters.

patch_endpoint Write

Partially update an endpoint. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id} (operationId: v1.endpoint.patch).

Lua path: app.integrations.svix.patch_endpoint
Full name: svix.svix_patch_endpoint

Parameter	Type	Required	Description
No parameters.

patch_endpoint_headers Write

Partially set the additional headers to be sent with the webhook. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers (operationId: v1.endpoint.patch-headers).

Lua path: app.integrations.svix.patch_endpoint_headers
Full name: svix.svix_patch_endpoint_headers

Parameter	Type	Required	Description
No parameters.

patch_endpoint_transformation Write

Set or unset the transformation code associated with this endpoint. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation (operationId: v1.endpoint.patch-transformation).

Lua path: app.integrations.svix.patch_endpoint_transformation
Full name: svix.svix_patch_endpoint_transformation

Parameter	Type	Required	Description
No parameters.

patch_event_type Write

Partially update an event type. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/event-type/{event_type_name} (operationId: v1.event-type.patch).

Lua path: app.integrations.svix.patch_event_type
Full name: svix.svix_patch_event_type

Parameter	Type	Required	Description
No parameters.

patch_ingest_endpoint_transformation Write

Set or unset the transformation code associated with this ingest endpoint. Official Svix API endpoint: PATCH https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/transformation (operationId: v1.ingest.endpoint.set-transformation).

Lua path: app.integrations.svix.patch_ingest_endpoint_transformation
Full name: svix.svix_patch_ingest_endpoint_transformation

Parameter	Type	Required	Description
No parameters.

patch_sink Write

Partially update a sink. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id} (operationId: v1.streaming.sink.patch).

Lua path: app.integrations.svix.patch_sink
Full name: svix.svix_patch_sink

Parameter	Type	Required	Description
No parameters.

patch_sink_headers Write

Updates the Sink's headers. Only valid for `http` or `otelTracing` sinks. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/headers (operationId: v1.streaming.sink-headers-patch).

Lua path: app.integrations.svix.patch_sink_headers
Full name: svix.svix_patch_sink_headers

Parameter	Type	Required	Description
No parameters.

patch_stream Write

Partially update a stream. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/stream/{stream_id} (operationId: v1.streaming.stream.patch).

Lua path: app.integrations.svix.patch_stream
Full name: svix.svix_patch_stream

Parameter	Type	Required	Description
No parameters.

patch_stream_event_type Write

Patch an event type for Streams. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/stream/event-type/{name} (operationId: v1.streaming.event-type.patch).

Lua path: app.integrations.svix.patch_stream_event_type
Full name: svix.svix_patch_stream_event_type

Parameter	Type	Required	Description
No parameters.

poller_consumer_poll Read

Reads the stream of created messages for an application, filtered on the Sink's event types and Channels, using server-managed iterator tracking. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id} (operationId: v1.message.poller.consumer-poll).

Lua path: app.integrations.svix.poller_consumer_poll
Full name: svix.svix_poller_consumer_poll

Parameter	Type	Required	Description
No parameters.

poller_consumer_seek Write

Sets the starting offset for the consumer of a polling endpoint. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}/seek (operationId: v1.message.poller.consumer-seek).

Lua path: app.integrations.svix.poller_consumer_seek
Full name: svix.svix_poller_consumer_seek

Parameter	Type	Required	Description
No parameters.

poller_poll Read

Reads the stream of created messages for an application, filtered on the Sink's event types and Channels. Official Svix API endpoint: GET https://api.svix.com/api/v1/app/{app_id}/poller/{sink_id} (operationId: v1.message.poller.poll).

Lua path: app.integrations.svix.poller_poll
Full name: svix.svix_poller_poll

Parameter	Type	Required	Description
No parameters.

poller_sink_stream_events Read

Iterate over a stream of events. The sink must be of type `poller` to use the poller endpoint. Official Svix API endpoint: GET https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/events (operationId: v1.streaming.events.get).

Lua path: app.integrations.svix.poller_sink_stream_events
Full name: svix.svix_poller_sink_stream_events

Parameter	Type	Required	Description
No parameters.

recover_failed_webhooks Write

Resend all failed messages since a given time. Messages that were sent successfully, even if failed initially, are not resent. A completed task will return a payload like the following: Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/recover (operationId: v1.endpoint.recover).

Lua path: app.integrations.svix.recover_failed_webhooks
Full name: svix.svix_recover_failed_webhooks

Parameter	Type	Required	Description
No parameters.

replay_missing_webhooks Write

Replays messages to the endpoint. Only messages that were created after `since` will be sent. Messages that were previously sent to the endpoint are not resent. A completed task will return a payload like the following: Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing (operationId: v1.endpoint.replay-missing).

Lua path: app.integrations.svix.replay_missing_webhooks
Full name: svix.svix_replay_missing_webhooks

Parameter	Type	Required	Description
No parameters.

resend_webhook Write

Resend a message to the specified endpoint. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend (operationId: v1.message-attempt.resend).

Lua path: app.integrations.svix.resend_webhook
Full name: svix.svix_resend_webhook

Parameter	Type	Required	Description
No parameters.

rotate_endpoint_secret Write

Rotates the endpoint's signing secret. The previous secret will remain valid for the next 24 hours. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate (operationId: v1.endpoint.rotate-secret).

Lua path: app.integrations.svix.rotate_endpoint_secret
Full name: svix.svix_rotate_endpoint_secret

Parameter	Type	Required	Description
No parameters.

rotate_ingest_endpoint_secret Write

Rotates an ingest endpoint's signing secret. The previous secret will remain valid for the next 24 hours. Official Svix API endpoint: POST https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret/rotate (operationId: v1.ingest.endpoint.rotate-secret).

Lua path: app.integrations.svix.rotate_ingest_endpoint_secret
Full name: svix.svix_rotate_ingest_endpoint_secret

Parameter	Type	Required	Description
No parameters.

rotate_ingest_token Write

Rotate the Ingest Source's Url Token. Official Svix API endpoint: POST https://api.svix.com/ingest/api/v1/source/{source_id}/token/rotate (operationId: v1.ingest.source.rotate-token).

Lua path: app.integrations.svix.rotate_ingest_token
Full name: svix.svix_rotate_ingest_token

Parameter	Type	Required	Description
No parameters.

rotate_integration_key Write

Rotate the integration's key. The previous key will be immediately revoked. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/integration/{integ_id}/key/rotate (operationId: v1.integration.rotate-key).

Lua path: app.integrations.svix.rotate_integration_key
Full name: svix.svix_rotate_integration_key

Parameter	Type	Required	Description
No parameters.

rotate_operational_webhook_endpoint_secret Write

Rotates an operational webhook endpoint's signing secret. The previous secret will remain valid for the next 24 hours. Official Svix API endpoint: POST https://api.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate (operationId: v1.operational-webhook.endpoint.rotate-secret).

Lua path: app.integrations.svix.rotate_operational_webhook_endpoint_secret
Full name: svix.svix_rotate_operational_webhook_endpoint_secret

Parameter	Type	Required	Description
No parameters.

rotate_poller_token Write

Create a new auth token for the stream poller API. Official Svix API endpoint: POST https://api.svix.com/api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token/rotate (operationId: v1.authentication.rotate-stream-poller-token).

Lua path: app.integrations.svix.rotate_poller_token
Full name: svix.svix_rotate_poller_token

Parameter	Type	Required	Description
No parameters.

rotate_sink_secret Write

Rotates the signing secret (only supported for http sinks). Official Svix API endpoint: POST https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/secret/rotate (operationId: v1.streaming.sink.rotate-secret).

Lua path: app.integrations.svix.rotate_sink_secret
Full name: svix.svix_rotate_sink_secret

Parameter	Type	Required	Description
No parameters.

send_event_type_example_message Write

Send an example message for an event. Official Svix API endpoint: POST https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example (operationId: v1.endpoint.send-example).

Lua path: app.integrations.svix.send_event_type_example_message
Full name: svix.svix_send_event_type_example_message

Parameter	Type	Required	Description
No parameters.

set_sink_transformation Write

Set or unset the transformation code associated with this sink. Official Svix API endpoint: PATCH https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/transformation (operationId: v1.streaming.sink.transformation-partial-update).

Lua path: app.integrations.svix.set_sink_transformation
Full name: svix.svix_set_sink_transformation

Parameter	Type	Required	Description
No parameters.

stream_expire_all Write

Expire all of the tokens associated with a specific stream. Official Svix API endpoint: POST https://api.svix.com/api/v1/auth/stream/{stream_id}/expire-all (operationId: v1.authentication.stream-expire-all).

Lua path: app.integrations.svix.stream_expire_all
Full name: svix.svix_stream_expire_all

Parameter	Type	Required	Description
No parameters.

stream_logout Write

Logout a stream token. Trying to log out other tokens will fail. Official Svix API endpoint: POST https://api.svix.com/api/v1/auth/stream-logout (operationId: v1.authentication.stream-logout).

Lua path: app.integrations.svix.stream_logout
Full name: svix.svix_stream_logout

Parameter	Type	Required	Description
No parameters.

update_application Write

Update an application. Official Svix API endpoint: PUT https://api.svix.com/api/v1/app/{app_id} (operationId: v1.application.update).

Lua path: app.integrations.svix.update_application
Full name: svix.svix_update_application

Parameter	Type	Required	Description
No parameters.

update_connector Write

Update a connector. Official Svix API endpoint: PUT https://api.svix.com/api/v1/connector/{connector_id} (operationId: v1.connector.update).

Lua path: app.integrations.svix.update_connector
Full name: svix.svix_update_connector

Parameter	Type	Required	Description
No parameters.

update_endpoint Write

Update an endpoint. Official Svix API endpoint: PUT https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id} (operationId: v1.endpoint.update).

Lua path: app.integrations.svix.update_endpoint
Full name: svix.svix_update_endpoint

Parameter	Type	Required	Description
No parameters.

update_endpoint_headers Write

Set the additional headers to be sent with the webhook. Official Svix API endpoint: PUT https://api.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers (operationId: v1.endpoint.update-headers).

Lua path: app.integrations.svix.update_endpoint_headers
Full name: svix.svix_update_endpoint_headers

Parameter	Type	Required	Description
No parameters.

update_event_type Write

Update an event type. Official Svix API endpoint: PUT https://api.svix.com/api/v1/event-type/{event_type_name} (operationId: v1.event-type.update).

Lua path: app.integrations.svix.update_event_type
Full name: svix.svix_update_event_type

Parameter	Type	Required	Description
No parameters.

update_ingest_endpoint Write

Update an ingest endpoint. Official Svix API endpoint: PUT https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id} (operationId: v1.ingest.endpoint.update).

Lua path: app.integrations.svix.update_ingest_endpoint
Full name: svix.svix_update_ingest_endpoint

Parameter	Type	Required	Description
No parameters.

update_ingest_endpoint_headers Write

Set the additional headers to be sent to the endpoint. Official Svix API endpoint: PUT https://api.svix.com/ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/headers (operationId: v1.ingest.endpoint.update-headers).

Lua path: app.integrations.svix.update_ingest_endpoint_headers
Full name: svix.svix_update_ingest_endpoint_headers

Parameter	Type	Required	Description
No parameters.

update_integration Write

Update an integration. Official Svix API endpoint: PUT https://api.svix.com/api/v1/app/{app_id}/integration/{integ_id} (operationId: v1.integration.update).

Lua path: app.integrations.svix.update_integration
Full name: svix.svix_update_integration

Parameter	Type	Required	Description
No parameters.

update_operational_webhook_endpoint Write

Update an operational webhook endpoint. Official Svix API endpoint: PUT https://api.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id} (operationId: v1.operational-webhook.endpoint.update).

Lua path: app.integrations.svix.update_operational_webhook_endpoint
Full name: svix.svix_update_operational_webhook_endpoint

Parameter	Type	Required	Description
No parameters.

update_operational_webhook_endpoint_headers Write

Set the additional headers to be sent with the operational webhook. Official Svix API endpoint: PUT https://api.svix.com/api/v1/operational-webhook/endpoint/{endpoint_id}/headers (operationId: v1.operational-webhook.endpoint.update-headers).

Lua path: app.integrations.svix.update_operational_webhook_endpoint_headers
Full name: svix.svix_update_operational_webhook_endpoint_headers

Parameter	Type	Required	Description
No parameters.

update_sink Write

Update a sink. Official Svix API endpoint: PUT https://api.svix.com/api/v1/stream/{stream_id}/sink/{sink_id} (operationId: v1.streaming.sink.update).

Lua path: app.integrations.svix.update_sink
Full name: svix.svix_update_sink

Parameter	Type	Required	Description
No parameters.

update_source Write

Update an Ingest Source. Official Svix API endpoint: PUT https://api.svix.com/ingest/api/v1/source/{source_id} (operationId: v1.ingest.source.update).

Lua path: app.integrations.svix.update_source
Full name: svix.svix_update_source

Parameter	Type	Required	Description
No parameters.

update_stream Write

Update a stream. Official Svix API endpoint: PUT https://api.svix.com/api/v1/stream/{stream_id} (operationId: v1.streaming.stream.update).

Lua path: app.integrations.svix.update_stream
Full name: svix.svix_update_stream

Parameter	Type	Required	Description
No parameters.

update_stream_event_type Write

Update or create a event type for Streams. Official Svix API endpoint: PUT https://api.svix.com/api/v1/stream/event-type/{name} (operationId: v1.streaming.event-type.update).

Lua path: app.integrations.svix.update_stream_event_type
Full name: svix.svix_update_stream_event_type

Parameter	Type	Required	Description
No parameters.