Svix API

Svix API

API version: 1.84.0

Auth

Bearer bearer

Base URL

https://api.eu.svix.com/

Setup

1. Set Authorization header with your Bearer token
2. GET /api/v1/app -- verify access
3. POST /api/v1/app -- create first app

Endpoints

127 endpoints across 2 groups. See references/api-spec.lap for full details.

api

ingest

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all app?" -> GET /api/v1/app
• "Create a app?" -> POST /api/v1/app
• "Get app details?" -> GET /api/v1/app/{app_id}
• "Update a app?" -> PUT /api/v1/app/{app_id}
• "Delete a app?" -> DELETE /api/v1/app/{app_id}
• "Partially update a app?" -> PATCH /api/v1/app/{app_id}
• "Get endpoint details?" -> GET /api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}
• "Get msg details?" -> GET /api/v1/app/{app_id}/attempt/msg/{msg_id}
• "List all endpoint?" -> GET /api/v1/app/{app_id}/endpoint
• "Create a endpoint?" -> POST /api/v1/app/{app_id}/endpoint
• "Get endpoint details?" -> GET /api/v1/app/{app_id}/endpoint/{endpoint_id}
• "Update a endpoint?" -> PUT /api/v1/app/{app_id}/endpoint/{endpoint_id}
• "Delete a endpoint?" -> DELETE /api/v1/app/{app_id}/endpoint/{endpoint_id}
• "Partially update a endpoint?" -> PATCH /api/v1/app/{app_id}/endpoint/{endpoint_id}
• "Create a bulk-replay?" -> POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay
• "List all headers?" -> GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers
• "List all msg?" -> GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/msg
• "Create a recover?" -> POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/recover
• "Create a replay-missing?" -> POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing
• "List all secret?" -> GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret
• "Create a rotate?" -> POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate
• "Create a send-example?" -> POST /api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example
• "List all stats?" -> GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/stats
• "List all transformation?" -> GET /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation
• "List all integration?" -> GET /api/v1/app/{app_id}/integration
• "Create a integration?" -> POST /api/v1/app/{app_id}/integration
• "Get integration details?" -> GET /api/v1/app/{app_id}/integration/{integ_id}
• "Update a integration?" -> PUT /api/v1/app/{app_id}/integration/{integ_id}
• "Delete a integration?" -> DELETE /api/v1/app/{app_id}/integration/{integ_id}
• "List all key?" -> GET /api/v1/app/{app_id}/integration/{integ_id}/key
• "Create a rotate?" -> POST /api/v1/app/{app_id}/integration/{integ_id}/key/rotate
• "List all msg?" -> GET /api/v1/app/{app_id}/msg
• "Create a msg?" -> POST /api/v1/app/{app_id}/msg
• "Create a expunge-all-content?" -> POST /api/v1/app/{app_id}/msg/expunge-all-contents
• "Get msg details?" -> GET /api/v1/app/{app_id}/msg/{msg_id}
• "Get attempt details?" -> GET /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}
• "List all endpoint?" -> GET /api/v1/app/{app_id}/msg/{msg_id}/endpoint
• "Create a resend?" -> POST /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend
• "Get poller details?" -> GET /api/v1/app/{app_id}/poller/{sink_id}
• "Get consumer details?" -> GET /api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}
• "Create a seek?" -> POST /api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}/seek
• "Create a expire-all?" -> POST /api/v1/auth/app/{app_id}/expire-all
• "Create a logout?" -> POST /api/v1/auth/logout
• "Create a stream-logout?" -> POST /api/v1/auth/stream-logout
• "Create a expire-all?" -> POST /api/v1/auth/stream/{stream_id}/expire-all
• "List all token?" -> GET /api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token
• "Create a rotate?" -> POST /api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token/rotate
• "List all background-task?" -> GET /api/v1/background-task
• "Get background-task details?" -> GET /api/v1/background-task/{task_id}
• "List all connector?" -> GET /api/v1/connector
• "Create a connector?" -> POST /api/v1/connector
• "Get connector details?" -> GET /api/v1/connector/{connector_id}
• "Update a connector?" -> PUT /api/v1/connector/{connector_id}
• "Delete a connector?" -> DELETE /api/v1/connector/{connector_id}
• "Partially update a connector?" -> PATCH /api/v1/connector/{connector_id}
• "Create a export?" -> POST /api/v1/environment/export
• "Create a import?" -> POST /api/v1/environment/import
• "List all event-type?" -> GET /api/v1/event-type
• "Create a event-type?" -> POST /api/v1/event-type
• "Create a openapi?" -> POST /api/v1/event-type/import/openapi
• "Get event-type details?" -> GET /api/v1/event-type/{event_type_name}
• "Update a event-type?" -> PUT /api/v1/event-type/{event_type_name}
• "Delete a event-type?" -> DELETE /api/v1/event-type/{event_type_name}
• "Partially update a event-type?" -> PATCH /api/v1/event-type/{event_type_name}
• "List all health?" -> GET /api/v1/health
• "List all endpoint?" -> GET /api/v1/operational-webhook/endpoint
• "Create a endpoint?" -> POST /api/v1/operational-webhook/endpoint
• "Get endpoint details?" -> GET /api/v1/operational-webhook/endpoint/{endpoint_id}
• "Update a endpoint?" -> PUT /api/v1/operational-webhook/endpoint/{endpoint_id}
• "Delete a endpoint?" -> DELETE /api/v1/operational-webhook/endpoint/{endpoint_id}
• "List all headers?" -> GET /api/v1/operational-webhook/endpoint/{endpoint_id}/headers
• "List all secret?" -> GET /api/v1/operational-webhook/endpoint/{endpoint_id}/secret
• "Create a rotate?" -> POST /api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate
• "Create a app?" -> POST /api/v1/stats/usage/app
• "List all stream?" -> GET /api/v1/stream
• "Create a stream?" -> POST /api/v1/stream
• "List all event-type?" -> GET /api/v1/stream/event-type
• "Create a event-type?" -> POST /api/v1/stream/event-type
• "Get event-type details?" -> GET /api/v1/stream/event-type/{name}
• "Update a event-type?" -> PUT /api/v1/stream/event-type/{name}
• "Delete a event-type?" -> DELETE /api/v1/stream/event-type/{name}
• "Partially update a event-type?" -> PATCH /api/v1/stream/event-type/{name}
• "Get stream details?" -> GET /api/v1/stream/{stream_id}
• "Update a stream?" -> PUT /api/v1/stream/{stream_id}
• "Delete a stream?" -> DELETE /api/v1/stream/{stream_id}
• "Partially update a stream?" -> PATCH /api/v1/stream/{stream_id}
• "Create a event?" -> POST /api/v1/stream/{stream_id}/events
• "List all sink?" -> GET /api/v1/stream/{stream_id}/sink
• "Create a sink?" -> POST /api/v1/stream/{stream_id}/sink
• "Get sink details?" -> GET /api/v1/stream/{stream_id}/sink/{sink_id}
• "Update a sink?" -> PUT /api/v1/stream/{stream_id}/sink/{sink_id}
• "Delete a sink?" -> DELETE /api/v1/stream/{stream_id}/sink/{sink_id}
• "Partially update a sink?" -> PATCH /api/v1/stream/{stream_id}/sink/{sink_id}
• "List all events?" -> GET /api/v1/stream/{stream_id}/sink/{sink_id}/events
• "List all headers?" -> GET /api/v1/stream/{stream_id}/sink/{sink_id}/headers
• "List all secret?" -> GET /api/v1/stream/{stream_id}/sink/{sink_id}/secret
• "Create a rotate?" -> POST /api/v1/stream/{stream_id}/sink/{sink_id}/secret/rotate
• "List all transformation?" -> GET /api/v1/stream/{stream_id}/sink/{sink_id}/transformation
• "List all source?" -> GET /ingest/api/v1/source
• "Create a source?" -> POST /ingest/api/v1/source
• "Get source details?" -> GET /ingest/api/v1/source/{source_id}
• "Update a source?" -> PUT /ingest/api/v1/source/{source_id}
• "Delete a source?" -> DELETE /ingest/api/v1/source/{source_id}
• "Create a dashboard?" -> POST /ingest/api/v1/source/{source_id}/dashboard
• "List all endpoint?" -> GET /ingest/api/v1/source/{source_id}/endpoint
• "Create a endpoint?" -> POST /ingest/api/v1/source/{source_id}/endpoint
• "Get endpoint details?" -> GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}
• "Update a endpoint?" -> PUT /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}
• "Delete a endpoint?" -> DELETE /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}
• "List all headers?" -> GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/headers
• "List all secret?" -> GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret
• "Create a rotate?" -> POST /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/secret/rotate
• "List all transformation?" -> GET /ingest/api/v1/source/{source_id}/endpoint/{endpoint_id}/transformation
• "Create a rotate?" -> POST /ingest/api/v1/source/{source_id}/token/rotate
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP