Skip to main content
Svix logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 37
  • Triggers: 0
  • Slug: SVIX
  • Version: 20261101_00

Tools

Slug: SVIX_APP_CREATETool to create a new Svix application. Use when you need to register an application with specific settings.

Input Parameters

string
Optional unique identifier for the application.
string
required
The name of the application to create.
object
Optional metadata key-value pairs (string values) for the application.
integer
Optional rate limit (messages per second) for this application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_APP_DELETEPermanently delete a Svix application by its ID or UID. Use this to remove an application and all its associated endpoints, messages, and webhooks. This action is destructive and cannot be undone.

Input Parameters

string
required
The application’s ID (e.g., ‘app_123abc456def’) or custom UID to delete. This permanently removes the application and all associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_APP_GETTool to retrieve details of a specific Svix application by its ID. Use when you need application metadata after authenticating with Svix.

Input Parameters

string
required
The application’s ID (e.g., ‘app_xxx’) or its UID if one was set during creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_APP_LISTTool to list all applications. Use when you need to retrieve or paginate through your Svix applications.

Input Parameters

integer
Number of items to return. Must be between 1 and 250. Defaults to server default (50).
string ("asc" | "desc")
Sorting order for the applications list.
string
Cursor for pagination. Use the iterator from a previous response to fetch the next set of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_APP_UPDATETool to update an existing Svix application by ID. Use when you need to modify properties like name, rate limit, UID, or metadata. Call after confirming the correct app_id.

Input Parameters

string
The new user-defined ID for the application.
string
The new name for the application.
string
required
The application’s unique ID or UID.
object
Key-value metadata pairs (string values) to associate with the application.
integer
The new rate limit for the application (messages per second). Must be at least 1 if set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ATTEMPT_GETTool to retrieve details of a specific message attempt. Use after confirming app_id, msg_id, and attempt_id.

Input Parameters

string
required
The Svix application ID (prefixed with ‘app_’) or custom UID.
string
required
The message ID (prefixed with ‘msg_’) to look up the attempt for.
string
required
The delivery attempt ID (prefixed with ‘atmpt_’) to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ATTEMPT_LISTTool to list all delivery attempts for a specific message. Use after confirming message ID to debug attempts.

Input Parameters

string
Only return attempts after this ISO 8601 datetime
integer
Maximum number of attempts to return per page (1-250). Defaults to 50 if not specified.
string
required
The Svix application ID (e.g., app_xxxx) containing the message
string
Only return attempts before this ISO 8601 datetime
string
required
The message ID (e.g., msg_xxxx) to list delivery attempts for
integer
Filter by attempt status: 0=pending, 1=success, 2=fail, 3=sending, 4=exhausted
string
Pagination cursor from a previous response’s ‘iterator’ field to fetch the next page
string
Filter attempts to only those for a specific endpoint ID
array
Filter by event type names of the original message
integer
Filter by HTTP status code class: 0 (none), 100 (1xx), 200 (2xx), 300 (3xx), 400 (4xx), 500 (5xx)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_CREATETool to create a new Svix webhook endpoint. Use after obtaining the app ID to register your webhook receiver URL.

Input Parameters

string
Optional unique identifier for the endpoint. Must be unique within the application.
string
required
The webhook endpoint URL that will receive POST requests with event payloads Must use HTTPS and be publicly accessible; localhost and private network URLs will fail delivery.
string
required
The application’s ID or UID. Use SVIX_APP_CREATE to create an application first.
string
Signing secret for webhook signature verification. Auto-generated if omitted. Must start with ‘whsec_’ prefix if provided.
integer
Endpoint version number. Defaults to 1 if not specified.
array
List of message channels to filter. Only messages sent to these channels will be delivered. Omit to receive messages from all channels.
boolean
Set to true to create the endpoint in a disabled state (won’t receive webhooks)
integer
Maximum number of webhook deliveries per second. Leave empty for no limit.
string
Human-readable description to identify the endpoint’s purpose
array
List of event type names to filter. Only these event types will be sent to this endpoint. Omit to receive all event types. Event type names must exactly match; mismatches silently prevent delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_DELETETool to delete an endpoint. Use when you need to remove a specific endpoint after confirming its application and endpoint IDs.

Input Parameters

string
required
The unique identifier of the application.
string
required
The unique identifier of the endpoint to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_GETTool to retrieve details of a specific endpoint. Use after confirming app_id and endpoint_id.

Input Parameters

string
required
The unique identifier of the Svix application.
string
required
The unique identifier of the webhook endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_LISTTool to list all endpoints for a specific application. Use after obtaining the application ID to retrieve its endpoints.

Input Parameters

integer
Maximum number of endpoints to return. Must be between 1 and 100. Defaults to server default (50).
string ("asc" | "desc")
Sorting order for the endpoints list.
string
required
The unique identifier of the application.
string
Cursor for pagination. Use the iterator from a previous response to fetch the next set of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_PATCHTool to partially update an endpoint’s configuration. Use when you need to adjust endpoint settings without full replacement.

Input Parameters

string
A custom unique identifier for the endpoint.
string
The URL to which the endpoint will send events.
string
required
The unique identifier of the Svix application.
string
Optional new signing secret; only include to rotate the secret.
array
List of delivery channels for this endpoint.
boolean
Whether the endpoint should be disabled.
integer
Rate limit for the endpoint (deliveries per second). Must be non-negative.
string
A new description for the endpoint.
string
required
The unique identifier of the endpoint to patch.
array
List of event types to forward to this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_PATCH_HEADERSTool to partially update headers for a specific endpoint. Use when you need to add, modify, or remove custom headers after endpoint creation.

Input Parameters

string
required
The unique identifier of the application.
object
required
A mapping of header names to values. Use string value to set or modify a header, or null to remove a header.
string
required
The unique identifier of the endpoint to update headers for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_RECOVER_FAILED_WEBHOOKSTool to recover messages that failed to send to an endpoint. Use when you need to retry webhook delivery for failed events after identifying delivery failures.

Input Parameters

string
required
Recover failed webhooks since this timestamp (ISO 8601). Must be within the last 14 days.
string
Recover failed webhooks up to this timestamp (ISO 8601). If not specified, recovers up to the current time.
string
required
The unique identifier of the Svix application.
string
required
The unique identifier of the Svix endpoint whose failed webhooks should be recovered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_REPLAY_MISSINGTool to replay missing webhooks for a specific endpoint. Use when some webhooks failed or were lost and need to be resent.

Input Parameters

string
required
Replay missing webhooks since this timestamp (ISO 8601). Must be within the last 14 days.
string
Replay missing webhooks up to this timestamp (ISO 8601). Defaults to now if not specified.
string
required
The unique identifier of the Svix application.
string
required
The unique identifier of the webhook endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_SECRET_GETTool to retrieve the secret for a specific endpoint. Use after confirming app_id and endpoint_id.

Input Parameters

string
required
The unique identifier of the Svix application.
string
required
The unique identifier of the webhook endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_SECRET_ROTATETool to rotate the signing secret key for an endpoint. Use when you need to invalidate the current secret and generate or supply a new one. Call after confirming app_id and endpoint_id.

Input Parameters

string
Optional new signing secret to use for rotation. Must be in the format ‘whsec_’ followed by a valid base64-encoded string (e.g., ‘whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw’). If omitted, a secret will be auto-generated by the server.
string
required
The unique identifier of the Svix application.
string
required
The unique identifier of the webhook endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_SEND_EXAMPLE_MESSAGETool to send a test message for a specific event type to an endpoint. Use after setting up an endpoint to verify its configuration. Note: the endpoint’s filter_types must include the event_type being tested; otherwise real events will not be delivered even if the example message sends successfully.

Input Parameters

string
required
The unique identifier of the Svix application.
string
required
The event type to send as an example. The event type must have a schema with examples defined.
string
required
The unique identifier of the Svix webhook endpoint.
object
Optional overrides for the default example payload. Use this to customize the example message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_STATS_GETTool to retrieve basic statistics for a specific endpoint. Use after confirming app_id and endpoint_id.

Input Parameters

string
required
The unique identifier of the Svix application.
string
required
The unique identifier of the webhook endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_TRANSFORMATION_GETTool to retrieve transformation settings for a specific endpoint. Use after confirming app_id and endpoint_id.

Input Parameters

string
required
The unique identifier of the Svix application.
string
required
The unique identifier of the webhook endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_TRANSFORMATION_SETTool to set or update transformation settings for an endpoint. Use when you need to configure or toggle an endpoint’s transformation code after creation.

Input Parameters

string
JavaScript code defining how to transform the webhook’s HTTP method, URL, or body payload.
string
required
The unique identifier of the Svix application.
boolean
Set to true to enable the transformation; false to disable it.
string
required
The unique identifier of the webhook endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_UPDATETool to update an existing endpoint or create it if it doesn’t exist (upsert). Use when you need to modify endpoint settings like URL, rate limit, channels, or metadata. If the endpoint doesn’t exist, a new one will be created with the specified endpoint_id as its uid.

Input Parameters

string
Custom unique identifier for the endpoint. Must be unique within the application.
string
required
The webhook URL to which events will be sent via POST request.
string
required
The app’s ID or UID. Use the application identifier where the endpoint belongs.
integer
The endpoint version number. Defaults to 1 if not specified.
array
List of message channels this endpoint subscribes to.
boolean
Set to true to disable the endpoint, false to enable it.
object
Key-value metadata to store with the endpoint. Values must be strings.
integer
Maximum messages per second to send to this endpoint. Use 0 or null for no limit.
string
Human-readable description for the endpoint.
string
required
The endpoint’s ID or UID. Use the endpoint identifier to update.
array
List of event types to deliver to this endpoint. If empty/null, all events are delivered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_ENDPOINT_UPDATE_HEADERSTool to completely replace headers for a specific endpoint. Use when you need to set a full new header mapping.

Input Parameters

string
required
The unique identifier of the application.
object
required
Mapping of header names to their values. All existing headers will be replaced.
string
required
The unique identifier of the endpoint to update headers for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_EVENT_TYPE_CREATECreate a new event type in Svix or unarchive an existing one. Event types are identifiers (like ‘order.created’, ‘user.signup’) that categorize the webhooks your application sends. Use period-delimited naming to group related events. Both ‘name’ and ‘description’ are required. Returns HTTP 409 if the event type already exists.

Input Parameters

string
required
Unique identifier for the event type. Use period-delimited naming like ‘group.event’ (e.g., ‘order.created’, ‘user.signup’, ‘invoice.paid’). This helps group related events in the UI.
object
Optional JSON Schema definitions for validating event payloads. Must be a mapping where the key is ‘1’ and the value is a JSONSchema (Draft 7) object. Example: {“1”: {“type”: “object”, “properties”: {…}}}. Note: Svix does not enforce schema validation when sending messages.
boolean
Set to false to unarchive a previously archived event type. Defaults to false for new event types.
string
required
Human-readable description explaining when this event type fires and what it represents.
string
Optional feature flag identifier to conditionally enable/disable this event type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_EVENT_TYPE_DELETETool to delete an event type. Use when you need to archive or permanently expunge a specific event type after confirming its name.

Input Parameters

boolean
If true, permanently delete the event type instead of archiving it.
string
required
The unique name (ID) of the event type to delete or archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_EVENT_TYPE_GETRetrieve details of a specific event type by its name. Use this to inspect an existing event type’s configuration, schema, and status. Event types define the categories of events that can be sent through Svix webhooks.

Input Parameters

string
required
The name of the event type to retrieve (e.g., ‘user.created’, ‘order.completed’). Event type names typically use dot-notation to represent hierarchical categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_EVENT_TYPE_LISTTool to retrieve a list of all event types. Use when you need to inspect available event types, optionally including their JSON schemas. Use after authenticating the client.

Input Parameters

integer
Maximum number of event types to return (1-100). Defaults to server default.
string
Cursor for pagination; use the iterator from a previous response to fetch next results.
boolean
If true, include the JSON schema for each event type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_EVENT_TYPE_UPDATEUpdate an existing event type’s description, schema, feature flags, or archive status. Use this to modify event type configuration. The event type must already exist - use List Event Types or Get Event Type to find valid event type names.

Input Parameters

object
Optional mapping of schema versions to JSON Schema definitions. Keys are version strings (e.g., ‘1’), values are JSON Schema objects.
boolean
Whether the event type should be marked as archived. Set to true to archive, false to unarchive.
string
required
Human-readable description of the event type. Required for update.
string
Optional single feature-flag key to associate with the event type.
string
required
The name of the event type to update (e.g., ‘user.created’, ‘order.completed’). Event type names typically use dot-notation to represent hierarchical categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_INTEGRATION_CREATETool to create a new integration for a specific application. Use after confirming the application ID.

Input Parameters

string
required
A descriptive name for the integration (e.g., ‘Zapier Integration’, ‘Make.com Webhook’).
string
required
The application’s ID or UID. Use app_list to find existing application IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_INTEGRATION_DELETEPermanently delete an integration from a Svix application. This is a destructive operation that cannot be undone. Use when removing webhook integrations that are no longer needed. Requires both the application ID and the integration ID. Use ‘List Integrations’ first if you need to find the integration_id.

Input Parameters

string
required
The application ID or UID. Can be the Svix-assigned ID (e.g., ‘app_1srOrx2ZWZBpBUvZwXKQmoEYga2’) or a custom UID you assigned when creating the app.
string
required
The unique identifier of the integration to delete. Starts with ‘integ_’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_INTEGRATION_GETTool to retrieve details of a specific integration. Use after confirming app_id and integration_id.

Input Parameters

string
required
The application’s ID or UID. Can be the internal app_id (e.g., ‘app_12345’) or the user-defined UID.
string
required
The unique identifier of the integration to retrieve (e.g., ‘integ_12345’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_INTEGRATION_LISTTool to list all integrations for a specific application. Use after confirming the application ID, supporting pagination via limit and iterator. Use when you need to enumerate integrations.

Input Parameters

integer
Maximum number of integrations to return (1-100). Defaults to server default.
string
required
The application’s ID or UID. Use an app_id (e.g., ‘app_12345’) or a custom UID if one was set.
string
Cursor for pagination; use the iterator from a previous response to fetch next results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_INTEGRATION_UPDATEUpdate an existing integration by application and integration ID, setting its name and optionally its feature flags.

Input Parameters

string
required
The new name for the integration.
string
required
The Application’s ID or UID.
string
required
The Integration’s ID (format: integ_XXXX…).
array
The set of feature flags the integration will have access to. Each flag must match pattern ^[a-zA-Z0-9-_.]+$.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_MESSAGE_CREATETool to create a new message for a specific application in Svix. Use after confirming app ID and event details.

Input Parameters

string
required
The unique identifier of the Svix application.
object
required
The JSON payload to include in the message event.
array
List of channels to deliver this message to (default: [’*’]).
string
required
The event type to dispatch (e.g., ‘order.created’).
string
Idempotency key for ensuring unique message creation.
integer
Number of days to retain the payload (1-90 days). Defaults to 90 days if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_MESSAGE_GETRetrieve details of a specific Svix message by application and message ID, including its metadata and payload.

Input Parameters

string
required
The unique identifier of the Svix application (e.g., ‘app_1srOrx2ZWZBpBUvZwXKQmoEYga2’).
string
required
The unique identifier of the Svix message (e.g., ‘msg_1srOrx2ZWZBpBUvZwXKQmoEYga2’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_MESSAGE_LISTTool to list all messages for a specific application. Use when you need to fetch or paginate messages after obtaining the application ID.

Input Parameters

string
Filter messages by tag.
string
Fetch messages created after this timestamp (ISO 8601 format).
integer
Maximum number of messages to return (1-100). Defaults to server default.
string
required
The application’s unique ID
string
Fetch messages created before this timestamp (ISO 8601 format).
integer
Filter messages by status code.
string
Filter messages by channel.
string
Cursor for pagination. Use the iterator from a previous response to fetch the next page.
array
Filter messages by one or more event types.
boolean
Include message payloads in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SVIX_SOURCE_CREATECreates a new Svix Ingest source for receiving webhooks from external providers. A source generates an ingest URL that you can share with a webhook provider (e.g., GitHub, Stripe) as the destination for their webhooks. Svix will verify signatures based on the source type and forward the webhooks to your configured endpoints. Use ‘genericWebhook’ type to skip signature verification for providers not natively supported.

Input Parameters

string
Optional unique identifier for the source. If not provided, one will be generated automatically.
string
required
The name of the source. Used to identify this source in the dashboard.
object
Provider-specific configuration. For most providers, this should contain a ‘secret’ key with the webhook signing secret. For ‘genericWebhook’, this can be empty or null.
string
required
The webhook provider type for signature verification. Use ‘genericWebhook’ to skip signature verification (useful for unsupported providers). Supported providers include: github, stripe, svix, shopify, slack, hubspot, clerk, zoom, docusign, beehiiv, brex, segment, resend, telnyx, airwallex, and many more.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not