Svix

svix

Svix is an enterprise-ready webhooks service that enables developers to send webhooks reliably and securely.

Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (37)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create ApplicationSVIX_APP_CREATEAcción

Tool to create a new svix application. use when you need to register an application with specific settings.

Parámetros de entrada

uidstring
Optional unique identifier for the application.
namestringObligatorio
The name of the application to create.
metadataobject
Optional metadata key-value pairs (string values) for the application.
rateLimitinteger
Optional rate limit (messages per second) for this application.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Svix ApplicationSVIX_APP_DELETEAcción

Tool to delete an application by its id. use when you need to permanently remove a svix application after confirming its id.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the application to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ApplicationSVIX_APP_GETAcción

Tool to retrieve details of a specific svix application by its id. use when you need application metadata after authenticating with svix.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ApplicationsSVIX_APP_LISTAcción

Tool to list all applications. use when you need to retrieve or paginate through your svix applications.

Parámetros de entrada

limitinteger
Number of items to return. Must be between 1 and 100. Defaults to server default (50).
orderstringenum
Sorting order for the applications list.
ascdesc
iteratorstring
Cursor for pagination. Use the iterator from a previous response to fetch the next set of results.

Parámetros de salida

dataobject[]Obligatorio
List of application objects.
errorstring
Error if any occurred during the execution of the action
iteratorstring
Cursor for the next page, null if there are no additional results.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
prev_iteratorstring
Cursor for the previous page, null if at the beginning of the list.

Update Svix ApplicationSVIX_APP_UPDATEAcción

Tool 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.

Parámetros de entrada

uidstring
The new user-defined ID for the application.
namestring
The new name for the application.
app_idstringObligatorio
The application's unique ID or UID.
metadataobject
Additional metadata for the application.
rateLimitinteger
The new rate limit for the application (requests per minute).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Attempt DetailsSVIX_ATTEMPT_GETAcción

Tool to retrieve details of a specific message attempt. use after confirming app id, msg id, and attempt id.

Parámetros de entrada

app_idstringObligatorio
The application's unique ID or UID.
msg_idstringObligatorio
The message's unique ID or UID.
attempt_idstringObligatorio
The attempt's unique ID or UID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Message AttemptsSVIX_ATTEMPT_LISTAcción

Tool to list all delivery attempts for a specific message. use after confirming message id to debug attempts.

Parámetros de entrada

limitinteger
Maximum number of attempts to return (1-100, default 50)
app_idstringObligatorio
The application's unique ID
msg_idstringObligatorio
The message's unique ID
iteratorstring
Pagination cursor for the next set of results
event_typesstring[]
Filter attempts by one or more event types

Parámetros de salida

dataobject[]Obligatorio
Array of attempt records as opaque dictionaries
errorstring
Error if any occurred during the execution of the action
totalinteger
Total number of attempts available
iteratorstring
Cursor for fetching the next page
successfulbooleanObligatorio
Whether or not the action execution was successful or not
prev_iteratorstring
Cursor for fetching the previous page

Create EndpointSVIX_ENDPOINT_CREATEAcción

Tool to create a new svix webhook endpoint. use after obtaining the app id to register your webhook receiver url.

Parámetros de entrada

urlstringObligatorio
Webhook endpoint URL that will receive POST requests
app_idstringObligatorio
ID of the Svix application to add the endpoint to
secretstring
Optional signing secret; auto-generated if omitted
versioninteger
Endpoint version number (default 1)
channelsstring[]
List of delivery channels for this endpoint
disabledboolean
Whether to disable the endpoint immediately upon creation
rate_limitinteger
Maximum deliveries per second (rate limit)
descriptionstring
Human-readable description for the endpoint
filter_typesstring[]
List of event types to forward to this endpoint

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete EndpointSVIX_ENDPOINT_DELETEAcción

Tool to delete an endpoint. use when you need to remove a specific endpoint after confirming its application and endpoint ids.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the application.
endpoint_idstringObligatorio
The unique identifier of the endpoint to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get EndpointSVIX_ENDPOINT_GETAcción

Tool to retrieve details of a specific endpoint. use after confirming app id and endpoint id.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
endpoint_idstringObligatorio
The unique identifier of the webhook endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List EndpointsSVIX_ENDPOINT_LISTAcción

Tool to list all endpoints for a specific application. use after obtaining the application id to retrieve its endpoints.

Parámetros de entrada

limitinteger
Maximum number of endpoints to return. Must be between 1 and 100. Defaults to server default (50).
orderstringenum
Sorting order for the endpoints list.
ascdesc
app_idstringObligatorio
The unique identifier of the application.
iteratorstring
Cursor for pagination. Use the iterator from a previous response to fetch the next set of results.

Parámetros de salida

dataobject[]Obligatorio
List of endpoint objects.
errorstring
Error if any occurred during the execution of the action
iteratorstring
Cursor for the next page, null if no more results.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
prev_iteratorstring
Cursor for the previous page, null if at beginning.

Patch EndpointSVIX_ENDPOINT_PATCHAcción

Tool to partially update an endpoint’s configuration. use when you need to adjust endpoint settings without full replacement.

Parámetros de entrada

uidstring
A custom unique identifier for the endpoint.
urlstring
The URL to which the endpoint will send events.
app_idstringObligatorio
The unique identifier of the Svix application.
secretstring
Optional new signing secret; only include to rotate the secret.
channelsstring[]
List of delivery channels for this endpoint.
disabledboolean
Whether the endpoint should be disabled.
rate_limitinteger
Rate limit for the endpoint (deliveries per second). Must be non-negative.
descriptionstring
A new description for the endpoint.
endpoint_idstringObligatorio
The unique identifier of the endpoint to patch.
filter_typesstring[]
List of event types to forward to this endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch Endpoint HeadersSVIX_ENDPOINT_PATCH_HEADERSAcción

Tool to partially update headers for a specific endpoint. use when you need to add, modify, or remove custom headers after endpoint creation.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Recover Failed WebhooksSVIX_ENDPOINT_RECOVER_FAILED_WEBHOOKSAcción

Tool 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.

Parámetros de entrada

sincestringObligatorio
Recover failed webhooks since this timestamp (ISO 8601).
untilstring
Recover failed webhooks up to this timestamp (ISO 8601).
app_idstringObligatorio
The unique identifier of the Svix application.
endpoint_idstringObligatorio
The unique identifier of the Svix endpoint whose failed webhooks should be recovered.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Replay Missing WebhooksSVIX_ENDPOINT_REPLAY_MISSINGAcción

Tool to replay missing webhooks for a specific endpoint. use when some webhooks failed or were lost and need to be resent.

Parámetros de entrada

sincestringObligatorio
Replay missing webhooks since this timestamp (ISO 8601).
untilstring
Replay missing webhooks up to this timestamp (ISO 8601).
app_idstringObligatorio
The unique identifier of the Svix application.
endpoint_idstringObligatorio
The unique identifier of the webhook endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Endpoint SecretSVIX_ENDPOINT_SECRET_GETAcción

Tool to retrieve the secret for a specific endpoint. use after confirming app id and endpoint id.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
endpoint_idstringObligatorio
The unique identifier of the webhook endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rotate Endpoint SecretSVIX_ENDPOINT_SECRET_ROTATEAcción

Tool 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.

Parámetros de entrada

keystring
Optional new secret to use for rotation. If omitted, a secret will be generated.
app_idstringObligatorio
The unique identifier of the Svix application.
endpoint_idstringObligatorio
The unique identifier of the webhook endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send Example MessageSVIX_ENDPOINT_SEND_EXAMPLE_MESSAGEAcción

Tool to send a test message for a specific event type to an endpoint. use after setting up an endpoint to verify its configuration.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
event_typestringObligatorio
The event type to send as an example.
endpoint_idstringObligatorio
The unique identifier of the Svix webhook endpoint.
payload_overridesobject
Optional overrides for the default example payload.

Parámetros de salida

idstringObligatorio
ID of the example message that was sent.
dataobjectObligatorio
Data of the sent example message.
errorstring
Error if any occurred during the execution of the action
statusstringObligatorio
Status of sending the example message.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Endpoint StatsSVIX_ENDPOINT_STATS_GETAcción

Tool to retrieve basic statistics for a specific endpoint. use after confirming app id and endpoint id.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
endpoint_idstringObligatorio
The unique identifier of the webhook endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Endpoint TransformationSVIX_ENDPOINT_TRANSFORMATION_GETAcción

Tool to retrieve transformation settings for a specific endpoint. use after confirming app id and endpoint id.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
endpoint_idstringObligatorio
The unique identifier of the webhook endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Endpoint TransformationSVIX_ENDPOINT_TRANSFORMATION_SETAcción

Tool to set or update transformation settings for an endpoint. use when you need to configure or toggle an endpoint's transformation code after creation.

Parámetros de entrada

codestring
JavaScript code defining how to transform the webhook's HTTP method, URL, or body payload.
app_idstringObligatorio
The unique identifier of the Svix application.
enabledboolean
Set to true to enable the transformation; false to disable it.
endpoint_idstringObligatorio
The unique identifier of the webhook endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update EndpointSVIX_ENDPOINT_UPDATEAcción

Tool to update an existing endpoint. use when you need to modify endpoint settings after creation.

Parámetros de entrada

uidstring
A unique identifier for the endpoint.
urlstringObligatorio
The URL to which the endpoint will send events.
app_idstringObligatorio
The unique identifier of the application.
versionstring
The version of the endpoint.
metadataobject
Additional metadata for the endpoint.
rateLimitinteger
The rate limit for the endpoint.
descriptionstring
A description of the endpoint.
endpoint_idstringObligatorio
The unique identifier of the endpoint to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Endpoint HeadersSVIX_ENDPOINT_UPDATE_HEADERSAcción

Tool to completely replace headers for a specific endpoint. use when you need to set a full new header mapping.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the application.
headersobjectObligatorio
Mapping of header names to their values. All existing headers will be replaced.
endpoint_idstringObligatorio
The unique identifier of the endpoint to update headers for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Event TypeSVIX_EVENT_TYPE_CREATEAcción

Tool to create a new event type or unarchive an existing one. use after confirming application context to register or revive an event type.

Parámetros de entrada

namestringObligatorio
Unique identifier for the event type
schemasobject
Optional mapping of content types to JSON schema definitions for this event type.
archivedboolean
Whether this event type is archived (set false to unarchive)
descriptionstring
Human-readable description of the event type
feature_flagstring
Optional feature flag key to gate this event type

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Event TypeSVIX_EVENT_TYPE_DELETEAcción

Tool to delete an event type. use when you need to archive or permanently expunge a specific event type after confirming its name.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Event TypeSVIX_EVENT_TYPE_GETAcción

Tool to retrieve details of a specific event type by its id. use when you need to inspect an existing event type after confirming its id.

Parámetros de entrada

event_type_idstringObligatorio
The unique identifier of the event type to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Event TypesSVIX_EVENT_TYPE_LISTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]Obligatorio
List of event type objects.
donebooleanObligatorio
True if this is the last page of results.
errorstring
Error if any occurred during the execution of the action
iteratorstring
Cursor for the next page; null if no further results.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Event TypeSVIX_EVENT_TYPE_UPDATEAcción

Tool to update an existing event type by id. use after confirming event type id to modify name, description, schemas, feature flag, or archive status.

Parámetros de entrada

namestringObligatorio
New name for the event type
schemasobject
Optional mapping of schema versions or examples to JSON Schema definitions. Each value must be a valid JSON Schema object.
archivedboolean
Whether the event type should be marked as archived
descriptionstring
Optional human-readable description of the event type
feature_flagstring
Optional feature-flag key to associate with the event type
event_type_idstringObligatorio
Unique identifier of the event type to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create IntegrationSVIX_INTEGRATION_CREATEAcción

Tool to create a new integration for a specific application. use after confirming the application id.

Parámetros de entrada

keystring
Optional pre-defined integration key
namestringObligatorio
The integration's name
app_idstringObligatorio
ID of the Svix application to add the integration to
endpointstring
Optional webhook or service endpoint URL (e.g., Slack, Discord)
descriptionstring
Optional human-readable description of the integration

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete IntegrationSVIX_INTEGRATION_DELETEAcción

Tool to delete an integration. use when you need to remove a specific integration after confirming its application and integration ids.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the application.
integration_idstringObligatorio
The unique identifier of the integration to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get IntegrationSVIX_INTEGRATION_GETAcción

Tool to retrieve details of a specific integration. use after confirming app id and integration id.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
integration_idstringObligatorio
The unique identifier of the integration to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List IntegrationsSVIX_INTEGRATION_LISTAcción

Tool 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.

Parámetros de entrada

limitinteger
Maximum number of integrations to return (1-100). Defaults to server default.
app_idstringObligatorio
The unique identifier of the Svix application.
iteratorstring
Cursor for pagination; use the iterator from a previous response to fetch next results.

Parámetros de salida

dataobject[]Obligatorio
List of integration objects.
errorstring
Error if any occurred during the execution of the action
iteratorstring
Cursor for the next page; null if no further results.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
prev_iteratorstring
Cursor for the previous page; null if at the beginning.

Update IntegrationSVIX_INTEGRATION_UPDATEAcción

Tool to update an existing integration by id. use when you need to modify integration settings like name, key, enabled status, or metadata after confirming the integration id.

Parámetros de entrada

keystring
New key associated with the integration.
namestring
New name for the integration.
app_idstringObligatorio
The unique identifier of the application.
enabledboolean
Whether to enable or disable the integration.
metadataobject
Additional key-value metadata to attach to the integration.
integration_idstringObligatorio
The unique identifier of the integration to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create MessageSVIX_MESSAGE_CREATEAcción

Tool to create a new message for a specific application in svix. use after confirming app id and event details.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
payloadobjectObligatorio
The JSON payload to include in the message event.
channelsstring[]
List of channels to deliver this message to (default: ['*']).
eventTypestringObligatorio
The event type to dispatch (e.g., 'order.created').
idempotencyKeystring
Idempotency key for ensuring unique message creation.
payloadRetentionPeriodinteger
Number of seconds to retain the payload (default: 31536000 seconds).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MessageSVIX_MESSAGE_GETAcción

Tool to retrieve details of a specific message by its id. use when you need message metadata and status after dispatch.

Parámetros de entrada

app_idstringObligatorio
The unique identifier of the Svix application.
msg_idstringObligatorio
The unique identifier of the Svix message.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List MessagesSVIX_MESSAGE_LISTAcción

Tool to list all messages for a specific application. use when you need to fetch or paginate messages after obtaining the application id.

Parámetros de entrada

tagstring
Filter messages by tag.
afterstring
Fetch messages created after this timestamp (ISO 8601 format).
limitinteger
Maximum number of messages to return (1-100). Defaults to server default.
app_idstringObligatorio
The application's unique ID
beforestring
Fetch messages created before this timestamp (ISO 8601 format).
statusinteger
Filter messages by status code.
channelstring
Filter messages by channel.
iteratorstring
Cursor for pagination. Use the iterator from a previous response to fetch the next page.
event_typesstring[]
Filter messages by one or more event types.
with_contentboolean
Include message payloads in the response.

Parámetros de salida

dataobject[]Obligatorio
List of message objects.
donebooleanObligatorio
True if this is the last page of results.
errorstring
Error if any occurred during the execution of the action
iteratorstring
Cursor for the next page; null if no more results.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create SourceSVIX_SOURCE_CREATEAcción

Tool to create a source for message ingestion. use to register a new source before creating ingest endpoints.

Parámetros de entrada

namestringObligatorio
The name of the source.
descriptionstring
Optional human-readable description for the source.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not