How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Svix Message API

Messages are the webhook events being sent.

Svix Message API is one of 29 APIs that Svix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Message. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 15 operations across 14 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.922.0.

Requests are made against 5 base URLs: https://api.eu.svix.com, https://api.us.svix.com, https://api.ca.svix.com, https://api.au.svix.com, https://api.in.svix.com.

15 operations 14 paths 27 schemas 1 DELETE7 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.922.0
Base URL
https://api.svix.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Svix Message API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

  • HTTPBearer — HTTP Bearer token passed in the Authorization header

Paths & Operations 15

Across 14 paths, the API surfaces 15 operations — 1 DELETE, 7 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Message 15

Messages are the webhook events being sent.

GET
/api/v1/app/{app_id}/msg
List Messages
v1.message.list 9 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/msg
Create Message
v1.message.create 3 params body → 202400401403404409422429
POST
/api/v1/app/{app_id}/msg/precheck/active
Create Message Precheck
v1.message.precheck 2 params body → 200400401403404409422429
GET
/api/v1/app/{app_id}/events
Message Events
v1.message.events 6 params → 200400401403404409422429
GET
/api/v1/app/{app_id}/msg/{msg_id}
Get Message
v1.message.get 3 params → 200400401403404409422429
DELETE
/api/v1/app/{app_id}/msg/{msg_id}/content
Delete message payload
v1.message.expunge-content 2 params → 204400401403404409422429
POST
/api/v1/app/{app_id}/msg/search
Search Messages
v1.message.search 2 params body → 200400401403404409422429
POST
/api/v1/app/{app_id}/msg/expunge-all-contents
Expunge all message contents
v1.message.expunge-all-contents 2 params → 202400401403404409422429
GET
/api/v1/app/{app_id}/msg/{msg_id}/raw
Get Raw Message Payload
v1.message.get-raw-payload 2 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/test-attempt
Create Message Attempt For Endpoint
v1.message.test-attempt 3 params body → 201400401403404409422429
GET
/api/v1/app/{app_id}/poller/{sink_id}
Poller Poll
v1.message.poller.poll 7 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}/seek
Poller Consumer Seek
v1.message.poller.consumer-seek 4 params body → 200400401403404409422429
GET
/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}
Poller Consumer Poll
v1.message.poller.consumer-poll 5 params → 200400401403404409422429
GET
/api/v1/app/{app_id}/polling-endpoint/{sink_id}/consumer/{consumer_id}
Pollerv2 Consumer Poll
v1.message.pollerv2.consumer-poll 6 params → 200400401403404409422429
POST
/api/v1/app/{app_id}/polling-endpoint/{sink_id}/consumer/{consumer_id}/commit
Pollerv2 Consumer Commit
v1.message.pollerv2.consumer-commit 4 params body → 204400401403404409422429

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are MessageAttemptOut (12 properties), MessageIn (10 properties), PollerV2MessageOut (10 properties), PollingEndpointMessageOut (9 properties). Each schema is shown below with its type and property counts.

PollerV2MessageOut
object
The MessageOut equivalent of polling endpoint
10 properties 5 required
ExpungeAllContentsOut
object
4 properties 4 required
PollerV2PollOut
object
2 properties 2 required
MessagePrecheckOut
object
1 property 1 required
PollingEndpointMessageOut
object
The MessageOut equivalent of polling endpoint
9 properties 4 required
MessageIn
object
10 properties 2 required
ApplicationIn
object
5 properties 1 required
PollerV2CommitIn
object
1 property 1 required
BackgroundTaskStatus
string
MessagePrecheckIn
object
2 properties 1 required
MessageStatusText
string
MessageRawPayloadOut
object
1 property 1 required
ListResponse_MessageOut_
object
4 properties 3 required
MessageSearchIn
object
8 properties
MessageAttemptOut
object
12 properties 11 required
HttpErrorOut
object
2 properties 2 required
MessageStatus
integer
The sending status of the message: - Success = 0 - Pending = 1 - Fail = 2 - Sending = 3 - Canceled = 4
HTTPValidationError
object
1 property 1 required
BackgroundTaskType
string
ValidationError
object
Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these…
3 properties 3 required
PollingEndpointConsumerSeekOut
object
1 property 1 required
PollingEndpointConsumerSeekIn
object
1 property 1 required
PollingEndpointOut
object
3 properties 3 required
StartingPosition
string
MessageEventsOut
object
3 properties 3 required
MessageOut
object
8 properties 4 required
MessageAttemptTriggerType
integer
The reason an attempt was made: - Scheduled = 0 - Manual = 1

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

svix-message-api-openapi.yml Raw ↑

Other APIs Svix publishes across the network.

Svix Open Source Server API
Svix Application API
Svix Authentication API
Svix Background Task API
Svix Connector API
Svix Endpoint API
Svix Environment API
Svix Event API
Svix Event Type API
Svix Health API
Svix Ingest Endpoint API
Svix Ingest Source API
Where this information came from

This is an independent, third-party profile of Svix Message API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.