Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
45 subscribers
213 ms avg latency
42 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Svix endpoints
| Method | Endpoint | Description |
|---|---|---|
| Application | ||
| POST |
create_application_api_v1_app__post /api/v1/app/ |
Create a new application. |
| GET |
get_application_api_v1_app__app_id___get /api/v1/app/{app_id}/ |
Get an application. |
| GET |
list_applications_api_v1_app__get /api/v1/app/ |
List of all the organization's applications. |
| PUT |
update_application_api_v1_app__app_id___put /api/v1/app/{app_id}/ |
Update an application. |
| DELETE |
delete_application_api_v1_app__app_id___delete /api/v1/app/{app_id}/ |
Delete an application. |
| Message | ||
| POST |
create_message_api_v1_app__app_id__msg__post /api/v1/app/{app_id}/msg/ |
Creates a new message and dispatches it to all of the application's endpoints. The `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after… |
| GET |
get_message_api_v1_app__app_id__msg__msg_id___get /api/v1/app/{app_id}/msg/{msg_id}/ |
Get a message by its ID or eventID. |
| GET |
list_messages_api_v1_app__app_id__msg__get /api/v1/app/{app_id}/msg/ |
List all of the application's messages. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed. The `after`… |
| Message Attempt | ||
| GET |
list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get /api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/ |
List attempts by endpoint id |
| GET |
list_attempts_api_v1_app__app_id__msg__msg_id__attempt__get /api/v1/app/{app_id}/msg/{msg_id}/attempt/ |
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. `msg_id`: Use a message id or a message `eventId` |
| POST |
resend_webhook_api_v1_app__app_id__msg__msg_id__endpoint__endpoint_id__resend__post /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend/ |
Resend a message to the specified endpoint. |
| GET |
list_attempted_destinations_api_v1_app__app_id__msg__msg_id__endpoint__get /api/v1/app/{app_id}/msg/{msg_id}/endpoint/ |
`msg_id`: Use a message id or a message `eventId` |
| GET |
list_attempted_messages_api_v1_app__app_id__endpoint__endpoint_id__msg__get /api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/ |
List messages for a particular endpoint. Additionally includes metadata about the latest message attempt. The `before` parameter lets you filter all items created before a… |
| GET |
get_attempt_api_v1_app__app_id__msg__msg_id__attempt__attempt_id___get /api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/ |
`msg_id`: Use a message id or a message `eventId` |
| GET |
list_attempts_for_endpoint_api_v1_app__app_id__msg__msg_id__endpoint__endpoint_id__attempt__get /api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/attempt/ |
DEPRECATED: please use list_attempts with endpoint_id as a query parameter instead. List the message attempts for a particular endpoint. Returning the endpoint. The `before`… |
| GET |
list_attempts_by_msg_api_v1_app__app_id__attempt_msg__msg_id___get /api/v1/app/{app_id}/attempt/msg/{msg_id}/ |
List attempts by message id |
| Endpoint | ||
| POST |
recover_failed_webhooks_api_v1_app__app_id__endpoint__endpoint_id__recover__post /api/v1/app/{app_id}/endpoint/{endpoint_id}/recover/ |
Resend all failed messages since a given time. |
| GET |
list_endpoints_api_v1_app__app_id__endpoint__get /api/v1/app/{app_id}/endpoint/ |
List the application's endpoints. |
| POST |
create_endpoint_api_v1_app__app_id__endpoint__post /api/v1/app/{app_id}/endpoint/ |
Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended) |
| GET |
get_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__get /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ |
Get the additional headers to be sent with the webhook |
| POST |
rotate_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret_rotate__post /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate/ |
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours. |
| DELETE |
delete_endpoint_api_v1_app__app_id__endpoint__endpoint_id___delete /api/v1/app/{app_id}/endpoint/{endpoint_id}/ |
Delete an endpoint. |
| PUT |
update_endpoint_api_v1_app__app_id__endpoint__endpoint_id___put /api/v1/app/{app_id}/endpoint/{endpoint_id}/ |
Update an endpoint. |
| PATCH |
patch_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__patch /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ |
Partially set the additional headers to be sent with the webhook |
| GET |
get_endpoint_api_v1_app__app_id__endpoint__endpoint_id___get /api/v1/app/{app_id}/endpoint/{endpoint_id}/ |
Get an application. |
| GET |
get_endpoint_secret_api_v1_app__app_id__endpoint__endpoint_id__secret__get /api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/ |
Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks… |
| PUT |
update_endpoint_headers_api_v1_app__app_id__endpoint__endpoint_id__headers__put /api/v1/app/{app_id}/endpoint/{endpoint_id}/headers/ |
Set the additional headers to be sent with the webhook |
| Integration | ||
| GET |
list_integrations_api_v1_app__app_id__integration__get /api/v1/app/{app_id}/integration/ |
List the application's integrations. |
| PUT |
update_integration_api_v1_app__app_id__integration__integ_id___put /api/v1/app/{app_id}/integration/{integ_id}/ |
Update an integration. |
| DELETE |
delete_integration_api_v1_app__app_id__integration__integ_id___delete /api/v1/app/{app_id}/integration/{integ_id}/ |
Delete an integration and revoke it's key. |
| GET |
get_integration_api_v1_app__app_id__integration__integ_id___get /api/v1/app/{app_id}/integration/{integ_id}/ |
Get an integration. |
| POST |
create_integration_api_v1_app__app_id__integration__post /api/v1/app/{app_id}/integration/ |
Create an integration. |
| POST |
rotate_integration_key_api_v1_app__app_id__integration__integ_id__key_rotate__post /api/v1/app/{app_id}/integration/{integ_id}/key/rotate/ |
Rotate the integration's key. The previous key will be immediately revoked. |
| GET |
get_integration_key_api_v1_app__app_id__integration__integ_id__key__get /api/v1/app/{app_id}/integration/{integ_id}/key/ |
Get an integration's key. |
| Event Type | ||
| POST |
create_event_type_api_v1_event_type__post /api/v1/event-type/ |
Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type… |
| DELETE |
delete_event_type_api_v1_event_type__event_type_name___delete /api/v1/event-type/{event_type_name}/ |
Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints… |
| PUT |
update_event_type_api_v1_event_type__event_type_name___put /api/v1/event-type/{event_type_name}/ |
Update an event type. |
| GET |
list_event_types_api_v1_event_type__get /api/v1/event-type/ |
Return the list of event types. |
| GET |
get_event_type_api_v1_event_type__event_type_name___get /api/v1/event-type/{event_type_name}/ |
Get an event type. |
| Authentication | ||
| POST |
get_dashboard_access_api_v1_auth_dashboard_access__app_id___post /api/v1/auth/dashboard-access/{app_id}/ |
Use this function to get magic links (and authentication codes) for connecting your users to the Application Portal. |
| POST |
logout_api_v1_auth_logout__post /api/v1/auth/logout/ |
Logout an app token. Trying to log out other tokens will fail. |
| Health | ||
| GET |
health_api_v1_health__get /api/v1/health/ |
Verify the API server is up and running. |
Svix pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
