Svix

Learn how to use Svix with Composio

Overview

SLUG: SVIX

Description

Svix is an enterprise-ready webhooks service that enables developers to send webhooks reliably and securely.

Authentication Details

generic_api_key
stringRequired

Connecting to Svix

Create an auth config

Use the dashboard to create an auth config for the Svix toolkit. This allows you to connect multiple Svix accounts to Composio for agents to use.

1

Select App

Navigate to Svix.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Svix Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4svix_auth_config_id = "ac_YOUR_SVIX_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Svix for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, svix_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Svix toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["SVIX"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Application

Description

Tool to create a new svix application. use when you need to register an application with specific settings.

Action Parameters

metadata
object
name
stringRequired
rateLimit
integer
uid
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Svix Application

Description

Tool to delete an application by its id. use when you need to permanently remove a svix application after confirming its id.

Action Parameters

app_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Application

Description

Tool to retrieve details of a specific svix application by its id. use when you need application metadata after authenticating with svix.

Action Parameters

app_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Applications

Description

Tool to list all applications. use when you need to retrieve or paginate through your svix applications.

Action Parameters

iterator
string
limit
integer
order
stringDefaults to desc

Action Response

data
arrayRequired
error
string
iterator
string
prev_iterator
string
successful
booleanRequired

Tool Name: Update Svix Application

Description

Tool to update an existing svix application by id. use when you need to modify properties like name, rate limit, uid, or metadata. call after confirming the correct app id.

Action Parameters

app_id
stringRequired
metadata
object
name
string
rateLimit
integer
uid
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Attempt Details

Description

Tool to retrieve details of a specific message attempt. use after confirming app id, msg id, and attempt id.

Action Parameters

app_id
stringRequired
attempt_id
stringRequired
msg_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Message Attempts

Description

Tool to list all delivery attempts for a specific message. use after confirming message id to debug attempts.

Action Parameters

app_id
stringRequired
event_types
array
iterator
string
limit
integer
msg_id
stringRequired

Action Response

data
arrayRequired
error
string
iterator
string
prev_iterator
string
successful
booleanRequired
total
integer

Tool Name: Create Endpoint

Description

Tool to create a new svix webhook endpoint. use after obtaining the app id to register your webhook receiver url.

Action Parameters

app_id
stringRequired
channels
array
description
string
disabled
boolean
filter_types
array
rate_limit
integer
secret
string
url
stringRequired
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Endpoint

Description

Tool to delete an endpoint. use when you need to remove a specific endpoint after confirming its application and endpoint ids.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Endpoint

Description

Tool to retrieve details of a specific endpoint. use after confirming app id and endpoint id.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Endpoints

Description

Tool to list all endpoints for a specific application. use after obtaining the application id to retrieve its endpoints.

Action Parameters

app_id
stringRequired
iterator
string
limit
integer
order
stringDefaults to asc

Action Response

data
arrayRequired
error
string
iterator
string
prev_iterator
string
successful
booleanRequired

Tool Name: Patch Endpoint

Description

Tool to partially update an endpoint’s configuration. use when you need to adjust endpoint settings without full replacement.

Action Parameters

app_id
stringRequired
channels
array
description
string
disabled
boolean
endpoint_id
stringRequired
filter_types
array
rate_limit
integer
secret
string
uid
string
url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Patch Endpoint Headers

Description

Tool to partially update headers for a specific endpoint. use when you need to add, modify, or remove custom headers after endpoint creation.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired
headers
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Recover Failed Webhooks

Description

Tool to recover messages that failed to send to an endpoint. use when you need to retry webhook delivery for failed events after identifying delivery failures.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired
since
stringRequired
until
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Replay Missing Webhooks

Description

Tool to replay missing webhooks for a specific endpoint. use when some webhooks failed or were lost and need to be resent.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired
since
stringRequired
until
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Endpoint Secret

Description

Tool to retrieve the secret for a specific endpoint. use after confirming app id and endpoint id.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Rotate Endpoint Secret

Description

Tool to rotate the signing secret key for an endpoint. use when you need to invalidate the current secret and generate or supply a new one. call after confirming app id and endpoint id.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired
key
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send Example Message

Description

Tool to send a test message for a specific event type to an endpoint. use after setting up an endpoint to verify its configuration.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired
event_type
stringRequired
payload_overrides
object

Action Response

data
objectRequired
error
string
id
stringRequired
status
stringRequired
successful
booleanRequired

Tool Name: Get Endpoint Stats

Description

Tool to retrieve basic statistics for a specific endpoint. use after confirming app id and endpoint id.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Endpoint Transformation

Description

Tool to retrieve transformation settings for a specific endpoint. use after confirming app id and endpoint id.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set Endpoint Transformation

Description

Tool to set or update transformation settings for an endpoint. use when you need to configure or toggle an endpoint's transformation code after creation.

Action Parameters

app_id
stringRequired
code
string
enabled
boolean
endpoint_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Endpoint

Description

Tool to update an existing endpoint. use when you need to modify endpoint settings after creation.

Action Parameters

app_id
stringRequired
description
string
endpoint_id
stringRequired
metadata
object
rateLimit
integer
uid
string
url
stringRequired
version
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Endpoint Headers

Description

Tool to completely replace headers for a specific endpoint. use when you need to set a full new header mapping.

Action Parameters

app_id
stringRequired
endpoint_id
stringRequired
headers
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Event Type

Description

Tool to create a new event type or unarchive an existing one. use after confirming application context to register or revive an event type.

Action Parameters

archived
boolean
description
string
feature_flag
string
name
stringRequired
schemas
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Event Type

Description

Tool to delete an event type. use when you need to archive or permanently expunge a specific event type after confirming its name.

Action Parameters

event_type_name
stringRequired
expunge
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Event Type

Description

Tool to retrieve details of a specific event type by its id. use when you need to inspect an existing event type after confirming its id.

Action Parameters

event_type_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Event Types

Description

Tool to retrieve a list of all event types. use when you need to inspect available event types, optionally including their json schemas. use after authenticating the client.

Action Parameters

iterator
string
limit
integer
with_content
boolean

Action Response

data
arrayRequired
done
booleanRequired
error
string
iterator
string
successful
booleanRequired

Tool Name: Update Event Type

Description

Tool to update an existing event type by id. use after confirming event type id to modify name, description, schemas, feature flag, or archive status.

Action Parameters

archived
boolean
description
string
event_type_id
stringRequired
feature_flag
string
name
stringRequired
schemas
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Integration

Description

Tool to create a new integration for a specific application. use after confirming the application id.

Action Parameters

app_id
stringRequired
description
string
endpoint
string
key
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Integration

Description

Tool to delete an integration. use when you need to remove a specific integration after confirming its application and integration ids.

Action Parameters

app_id
stringRequired
integration_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Integration

Description

Tool to retrieve details of a specific integration. use after confirming app id and integration id.

Action Parameters

app_id
stringRequired
integration_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Integrations

Description

Tool to list all integrations for a specific application. use after confirming the application id, supporting pagination via limit and iterator. use when you need to enumerate integrations.

Action Parameters

app_id
stringRequired
iterator
string
limit
integer

Action Response

data
arrayRequired
error
string
iterator
string
prev_iterator
string
successful
booleanRequired

Tool Name: Update Integration

Description

Tool to update an existing integration by id. use when you need to modify integration settings like name, key, enabled status, or metadata after confirming the integration id.

Action Parameters

app_id
stringRequired
enabled
boolean
integration_id
stringRequired
key
string
metadata
object
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Message

Description

Tool to create a new message for a specific application in svix. use after confirming app id and event details.

Action Parameters

app_id
stringRequired
channels
array
eventType
stringRequired
idempotencyKey
string
payload
objectRequired
payloadRetentionPeriod
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Message

Description

Tool to retrieve details of a specific message by its id. use when you need message metadata and status after dispatch.

Action Parameters

app_id
stringRequired
msg_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Messages

Description

Tool to list all messages for a specific application. use when you need to fetch or paginate messages after obtaining the application id.

Action Parameters

after
string
app_id
stringRequired
before
string
channel
string
event_types
array
iterator
string
limit
integer
status
integer
tag
string
with_content
boolean

Action Response

data
arrayRequired
done
booleanRequired
error
string
iterator
string
successful
booleanRequired

Tool Name: Create Source

Description

Tool to create a source for message ingestion. use to register a new source before creating ingest endpoints.

Action Parameters

description
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired