canonical: https://jentic.com/apis/svix.com/svix

# Svix API

Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the do. The API exposes 88 endpoints secured with bearer authentication.

## For AI agents

Programmatically create ingest source, list ingest sources. Covers 88 operations with bearer authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Create Ingest Source
- List Ingest Sources
- Get Ingest Source
- Update Source
- Delete Ingest Source
- Rotate Ingest Token
- Ingest Source Consumer Portal

## Use cases

### CRM Operations

Use the Svix API to perform crm operations programmatically. The API provides 88 endpoints covering core functionality including create ingest source, list ingest sources, get ingest source.

Example prompt: Call POST `/ingest/api/v1/source` to create ingest source

### Automated Application Management

Automate application operations by combining multiple Svix API endpoints. Agents can list ingest sources and then get ingest source in a single workflow.

Example prompt: Call GET `/ingest/api/v1/source` to list ingest sources, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Svix API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'create ingest source', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/ingest/api/v1/source` | Create Ingest Source |
| GET | `/ingest/api/v1/source` | List Ingest Sources |
| GET | `/ingest/api/v1/source/{source_id}` | Get Ingest Source |
| PUT | `/ingest/api/v1/source/{source_id}` | Update Source |
| DELETE | `/ingest/api/v1/source/{source_id}` | Delete Ingest Source |
| POST | `/ingest/api/v1/source/{source_id}/token/rotate` | Rotate Ingest Token |
| POST | `/ingest/api/v1/source/{source_id}/dashboard` | Ingest Source Consumer Portal |
| POST | `/ingest/api/v1/source/{source_id}/endpoint` | Create Ingest Endpoint |

## Key resources

- **Application** — Consumer Applications are where messages are sent to. In most cases you would want to have one appli
- **Message** — Messages are the webhook events being sent.
- **Message Attempt** — Attempts to deliver `Message`s to `Endpoint`s.
- **Endpoint** — Endpoints are the URLs messages will be sent to. Each application can have up to 50 endpoints and ea
- **Integration** — Integrations are services your users connect an application to. An integration can manage the applic

## Why Jentic

- **Setup:** Wiring Svix by hand means learning its bearer auth, choosing the right EU or US host, and handling its ingest source and endpoint calls yourself. Through Jentic you install once, import the Svix API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Svix puts the ingest source id in the URL path (`/ingest/api/v1/source/{source_id}/...`), so a rule can pin your agent to one source: it can read and add endpoints for that source and nothing else. You choose the operations it may call, so destructive ones like source deletion or token rotation are not included unless you add them.
- **Credential handling:** Your Svix token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an ingest source' or 'list ingest sources', and Jentic returns the matching Svix operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Svix API use?

The Svix API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create ingest source with the Svix API?

Yes. Use the POST `/ingest/api/v1/source` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Svix API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create ingest source through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create ingest source'. Jentic returns the matching Svix API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Svix API have?

The Svix API exposes 88 endpoints covering application, message, message attempt operations.

### Can I limit what my agent is allowed to do with the Svix API?

Yes. Because you run Jentic One yourself, you decide which Svix operations your agent may call and which stored token it uses. Since Svix puts the ingest source id in the URL path (`/ingest/api/v1/source/{source_id}/...`), a rule can pin the agent to a single source so it only reads and adds endpoints for that source and nothing else. Destructive operations such as deleting a source or rotating an ingest token are excluded unless you explicitly grant them.
