Svix

Svix Connector API

Connectors allow you to connect applications to external services.

GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/connector List connectors · List Connectors #
Ask an LLM
“What connectors have I built for my Svix environment?”
“Can I filter my connectors by product type?”
Tell an agent
List all my connectors.
Show connectors for product type {product_type}, {limit} at a time.
POST /api/v1/connector Create a connector · Create Connector #
Ask an LLM
“How do I publish a new pre-built connector that my customers can pick for their endpoints?”
“Can a new connector restrict which event types it accepts?”
Tell an agent
Create a connector named {name} with transformation code {transformation}.
Create connector {name} using transformation {transformation}, allowing only {allowedEventTypes}, with setup instructions {instructions}.
GET /api/v1/connector/{connector_id} Get a connector · Get Connector #
Ask an LLM
“What transformation and allowed event types does a specific connector have?”
“Can I view one connector's logo and setup instructions?”
Tell an agent
Show connector {connector_id}.
Fetch the full details of connector {connector_id}.
PUT /api/v1/connector/{connector_id} Create or replace a connector · Upsert Connector #
Ask an LLM
“Can I upsert a connector so it's created if that ID doesn't exist yet?”
“How do I replace a connector's whole definition, transformation included?”
Tell an agent
Upsert connector {connector_id} with transformation {transformation}.
Replace connector {connector_id} entirely: name {name}, transformation {transformation}.
DELETE /api/v1/connector/{connector_id} Delete a connector · Delete Connector #
Ask an LLM
“How do I remove a connector I no longer offer?”
“Can I permanently delete a connector?”
Tell an agent destructive · confirm first
Delete connector {connector_id}.
Remove connector {connector_id} for good.
PATCH /api/v1/connector/{connector_id} Change some fields of a connector · Patch Connector #
Ask an LLM
“Can I update just a connector's logo or description?”
“How do I tweak one connector field without resending its transformation?”
Tell an agent
Change the description of connector {connector_id} to {description}.
Partially update connector {connector_id} with the logo {logo}.
GET /api/v1/connector/{connector_id}/options Get a connector's options · Get Connector Options #
Ask an LLM
“What options are configured on a connector?”
“Can I read back the option settings for one connector?”
Tell an agent
Show the options of connector {connector_id}.
Fetch connector {connector_id}'s option settings.
PUT /api/v1/connector/{connector_id}/options Set a connector's options · Set Connector Options #
Ask an LLM
“How do I change the options on a connector?”
“Can I overwrite a connector's option settings?”
Tell an agent
Set the options for connector {connector_id}.
Save new option settings on connector {connector_id}.
POST /api/v1/connector/simulate Test connector transformation code on a payload · Simulate #
Ask an LLM
“Can I try out connector transformation code on a sample event before saving it?”
“What would a payload look like after a connector's transformation?”
Tell an agent
Simulate connector code {code} on a {eventType} event with payload {payload}.
Dry-run connector transformation {code} against payload {payload} as event type {eventType} on channels {channels}.
POST /api/v1/connector/oauth/slack Exchange a Slack OAuth code for a webhook URL · Authorize Slack #
Ask an LLM
“How do I turn a Slack OAuth code into an incoming webhook URL for a connector?”
“What does the Slack connector authorization need from the redirect?”
Tell an agent
Exchange Slack authorization code {code} with redirect URI {redirectUri} for an incoming webhook URL.
Authorize Slack with code {code} and redirect {redirectUri}.
POST /api/v1/connector/oauth/discord Exchange a Discord OAuth code for a webhook URL · Authorize Discord #
Ask an LLM
“How do I turn a Discord OAuth code into an incoming webhook URL?”
“Which values does the Discord connector authorization require?”
Tell an agent
Exchange Discord authorization code {code} with redirect URI {redirectUri} for an incoming webhook URL.
Authorize Discord with code {code} and redirect {redirectUri}.
POST /api/v1/connector/oauth/hubspot Exchange a HubSpot OAuth code for an access token · Authorize Hubspot #
Ask an LLM
“How do I get a HubSpot access token from an authorization code for a connector?”
“What does the HubSpot connector authorization need from the OAuth redirect?”
Tell an agent
Exchange HubSpot authorization code {code} with redirect URI {redirectUri} for an access token.
Authorize HubSpot with code {code} and redirect {redirectUri}.
PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}/connector/oauth/hubspot Store HubSpot OAuth credentials on an endpoint · Update Hubspot Oauth Config #
Ask an LLM
“How do I save a HubSpot refresh token on an endpoint without exposing the secret to the client?”
“Can I update the HubSpot OAuth setup of an existing endpoint?”
Tell an agent
Set the HubSpot refresh token {refresh_token} on endpoint {endpoint_id} in app {app_id}.
Update endpoint {endpoint_id}'s HubSpot OAuth config on app {app_id} with refresh token {refresh_token}.

Documentation

📖
Documentation
https://docs.svix.com
📖
APIReference
https://api.svix.com/docs
📖
Authentication
https://docs.svix.com/api-keys
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/rate-limits/svix-rate-limits.yml
📖
Documentation
https://www.svix.com/ingest/
📖
Documentation
https://www.svix.com/stream/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-connector-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/overlays/svix-connector-api-overlay.yaml
🔗
ErrorCodes
https://docs.svix.com/retries

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/svix:svix-connector-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

svix-connector-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Svix Connector API
  description: Welcome to the Svix API documentation!
  version: 1.922.0
  x-logo:
    url: https://www.svix.com/static/img/brand-padded.svg
    altText: Svix Logo
servers:
- url: https://api.eu.svix.com
  description: The Svix EU region
- url: https://api.us.svix.com
  description: The Svix US region
- url: https://api.ca.svix.com
  description: The Svix Canada region
- url: https://api.au.svix.com
  description: The Svix Australia region
- url: https://api.in.svix.com
  description: The Svix India region
tags:


# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-connector-api-openapi.yml