Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:[email protected]) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
auth: b e a r
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:[email protected]) | [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 [t
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/v1/app/ | List Applications List of all the organization's applications. Application |
POST | /api/v1/app/ | Create Application Create a new application. Application |
GET | /api/v1/app/{app_id}/ | Get Application Get an application. Application |
PUT | /api/v1/app/{app_id}/ | Update Application Update an application. Application |
DELETE | /api/v1/app/{app_id}/ | Delete Application Delete an application. Application |
GET | /api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/ | List Attempts By Endpoint List attempts by endpoint id Message Attempt |
GET | /api/v1/app/{app_id}/attempt/msg/{msg_id}/ | List Attempts By Msg List attempts by message id Message Attempt |
GET | /api/v1/app/{app_id}/endpoint/ | List Endpoints List the application's endpoints. Endpoint |
POST | /api/v1/app/{app_id}/endpoint/ | Create Endpoint Create a new endpoint for the application. When `secret` is `null` the secret is automaticall |
GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Get Endpoint Get an application. Endpoint |
PUT | /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Update Endpoint Update an endpoint. Endpoint |
DELETE | /api/v1/app/{app_id}/endpoint/{endpoint_id}/ | Delete Endpoint Delete an endpoint. Endpoint |
GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Get Endpoint Headers Get the additional headers to be sent with the webhook Endpoint |
PUT | /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Update Endpoint Headers Set the additional headers to be sent with the webhook Endpoint |
PATCH | /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ | Patch Endpoint Headers Partially set the additional headers to be sent with the webhook Endpoint |
GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/ | List Attempted Messages List messages for a particular endpoint. Additionally includes metadata about the late |
POST | /api/v1/app/{app_id}/endpoint/{endpoint_id}/recover/ | Recover Failed Webhooks Resend all failed messages since a given time. Endpoint |
POST | /api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing/ | Replay Missing Webhooks Replays messages to the endpoint. Only messages that were created after `since` will b |
GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/ | Get Endpoint Secret Get the endpoint's signing secret. This is used to verify the authenticity of the webhook |
POST | /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate/ | Rotate Endpoint Secret Rotates the endpoint's signing secret. The previous secret will be valid for the next |
GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/stats/ | Get Endpoint Stats Get basic statistics for the endpoint. Endpoint |
GET | /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation/ | Get Endpoint Transformation Get the transformation code associated with this endpoint Endpoint |
PATCH | /api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation/ | Set Endpoint Transformation Set or unset the transformation code associated with this endpoint Endpoint |
GET | /api/v1/app/{app_id}/integration/ | List Integrations List the application's integrations. Integration |
POST | /api/v1/app/{app_id}/integration/ | Create Integration Create an integration. Integration |
GET | /api/v1/app/{app_id}/integration/{integ_id}/ | Get Integration Get an integration. Integration |
PUT | /api/v1/app/{app_id}/integration/{integ_id}/ | Update Integration Update an integration. Integration |
DELETE | /api/v1/app/{app_id}/integration/{integ_id}/ | Delete Integration Delete an integration and revoke it's key. Integration |
GET | /api/v1/app/{app_id}/integration/{integ_id}/key/ | Get Integration Key Get an integration's key. Integration |
POST | /api/v1/app/{app_id}/integration/{integ_id}/key/rotate/ | Rotate Integration Key Rotate the integration's key. The previous key will be immediately revoked. Integration |
GET | /api/v1/app/{app_id}/msg/ | List Messages List all of the application's messages. The `before` parameter lets you filter all items create |
POST | /api/v1/app/{app_id}/msg/ | Create Message Creates a new message and dispatches it to all of the application's endpoints. The `eventId` i |
GET | /api/v1/app/{app_id}/msg/{msg_id}/ | Get Message Get a message by its ID or eventID. Message |
GET | /api/v1/app/{app_id}/msg/{msg_id}/attempt/ | List Attempts Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. `msg_id` |
GET | /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/ | Get Attempt `msg_id`: Use a message id or a message `eventId` Message Attempt |
DELETE | /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/content/ | Delete attempt response body Deletes the given attempt's response body. Useful when an endpoint accidentally r |
DELETE | /api/v1/app/{app_id}/msg/{msg_id}/content/ | Delete message payload Delete the given message's payload. Useful in cases when a message was accidentally sen |
GET | /api/v1/app/{app_id}/msg/{msg_id}/endpoint/ | List Attempted Destinations `msg_id`: Use a message id or a message `eventId` Message Attempt |
GET | /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/attempt/ | List Attempts For Endpoint DEPRECATED: please use list_attempts with endpoint_id as a query parameter instead. |
POST | /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend/ | Resend Webhook Resend a message to the specified endpoint. Message Attempt |
and 12 more operation(s) in this specification, all searchable.
specification origin: https://api.svix.com/api/v1/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.