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 can not filter on it. An event type can be unarchived with the [create operation](#operation/create_event_type_api_v1_event_type__post). If `expunge=true` is set then the event type is deleted instead of archived. This can only be used in development environments.
Create a new application.
Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended)
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 before archival will continue to filter on it. This operation does not preserve the description and schemas.
Create an integration.
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 that no verification will be made. If a message with the same `eventId` already exists for any application in your environment, a 409 conflict error will be returned. The `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema. The `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to ~350kb, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb. The optional `application` property will be used to create an application if the application referenced in the path does not exist. If it does then this property is ignored.
Delete an application.
Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content.
Delete an endpoint.
Delete an integration and revoke it's key.
Delete the given message's payload. Useful in cases when a message was accidentally sent with sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
Expire all of the tokens associated with a specific Application
Get an application.
`msg_id`: Use a message id or a message `eventId`
Get a background task by ID.
Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
DEPRECATED: Please use `app-portal-access` instead. Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.
Get an application.
Get the additional headers to be sent with the webhook
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 docs](https://docs.svix.com/consuming-webhooks/).
Get basic statistics for the endpoint.
Get the transformation code associated with this endpoint
Get an event type.
Get an integration.
Get an integration's key.
Get a message by its ID or eventID.
List of all the organization's applications.
`msg_id`: Use a message id or a message `eventId`
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 certain date and is ignored if an iterator is passed.
Deprecated: Please use "List Attempts by Endpoint" and "List Attempts by Msg" instead. `msg_id`: Use a message id or a message `eventId`
List attempts by endpoint id
List attempts by message id
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` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
List background tasks executed in the past 90 days.
List the application's endpoints.
Return the list of event types.
List the application's integrations.
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` parameter lets you filter all items created after a certain date and is ignored if an iterator is passed. `before` and `after` cannot be used simultaneously.
Logout an app token. Trying to log out other tokens will fail.
Partially set the additional headers to be sent with the webhook
Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
Rotate the integration's key. The previous key will be immediately revoked.
Set or unset the transformation code associated with this endpoint
Update an application.
Update an endpoint.
Set the additional headers to be sent with the webhook
Update an event type.
Update an integration.
Tell us which provider you need, and we will ship it in the registry.
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.