Skip to main content
Server path: /svix-integrations | Type: Application | PCID required: Yes

Tools

ToolDescription
svix_integrations_v1_connector_createCreate Connector
svix_integrations_v1_connector_deleteDelete Connector
svix_integrations_v1_connector_getGet Connector
svix_integrations_v1_connector_listList Connectors
svix_integrations_v1_connector_patchPatch Connector
svix_integrations_v1_connector_updateUpdate Connector
svix_integrations_v1_integration_createCreate Integration
svix_integrations_v1_integration_deleteDelete Integration
svix_integrations_v1_integration_getGet Integration
svix_integrations_v1_integration_listList Integrations
svix_integrations_v1_integration_rotate_keyRotate Integration Key
svix_integrations_v1_integration_updateUpdate Integration
svix_integrations_v1_operational_webhook_endpoint_createCreate Operational Webhook Endpoint
svix_integrations_v1_operational_webhook_endpoint_deleteDelete Operational Webhook Endpoint
svix_integrations_v1_operational_webhook_endpoint_getGet Operational Webhook Endpoint
svix_integrations_v1_operational_webhook_endpoint_get_headersGet Operational Webhook Endpoint Headers
svix_integrations_v1_operational_webhook_endpoint_get_secretGet Operational Webhook Endpoint Secret
svix_integrations_v1_operational_webhook_endpoint_listList Operational Webhook Endpoints
svix_integrations_v1_operational_webhook_endpoint_rotate_secretRotate Operational Webhook Endpoint Secret
svix_integrations_v1_operational_webhook_endpoint_updateUpdate Operational Webhook Endpoint
svix_integrations_v1_operational_webhook_endpoint_update_headersUpdate Operational Webhook Endpoint Headers

svix_integrations_v1_connector_create

Create Connector Parameters:
ParameterTypeRequiredDefaultDescription
allowedEventTypesstring[]NoAllowed Event Types
descriptionstringNoThe description value
featureFlagsstring[]NoFeature Flags
instructionsstringNoThe instructions value
kindstringNoThe kind value
logostringNoThe logo value
namestringYesThe name value
productTypestringNoProduct Type
transformationstringYesThe transformation value
uidstringNoThe Connector’s UID.

svix_integrations_v1_connector_delete

Delete Connector Parameters:
ParameterTypeRequiredDefaultDescription
connector_idstringYesThe Connector’s ID or UID.

svix_integrations_v1_connector_get

Get Connector Parameters:
ParameterTypeRequiredDefaultDescription
connector_idstringYesThe Connector’s ID or UID.

svix_integrations_v1_connector_list

List Connectors Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items
product_typestringNoProduct Type

svix_integrations_v1_connector_patch

Patch Connector Parameters:
ParameterTypeRequiredDefaultDescription
connector_idstringYesThe Connector’s ID or UID.
allowedEventTypesstring[]NoAllowed Event Types
descriptionstringNoThe description value
featureFlagsstring[]NoFeature Flags
instructionsstringNoThe instructions value
kindstringNoThe kind value
logostringNoThe logo value
namestringNoThe name value
transformationstringNoThe transformation value

svix_integrations_v1_connector_update

Update Connector Parameters:
ParameterTypeRequiredDefaultDescription
connector_idstringYesThe Connector’s ID or UID.
allowedEventTypesstring[]NoAllowed Event Types
descriptionstringNoThe description value
featureFlagsstring[]NoFeature Flags
instructionsstringNoThe instructions value
kindstringNoThe kind value
logostringNoThe logo value
namestringNoThe name value
transformationstringYesThe transformation value

svix_integrations_v1_integration_create

Create Integration Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
featureFlagsstring[]NoThe set of feature flags the integration will have access to.
namestringYesThe name value

svix_integrations_v1_integration_delete

Delete Integration Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
integ_idstringYesThe Integration’s ID.

svix_integrations_v1_integration_get

Get Integration Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
integ_idstringYesThe Integration’s ID.

svix_integrations_v1_integration_list

List Integrations Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items

svix_integrations_v1_integration_rotate_key

Rotate Integration Key Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
integ_idstringYesThe Integration’s ID.

svix_integrations_v1_integration_update

Update Integration Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesThe Application’s ID or UID.
integ_idstringYesThe Integration’s ID.
featureFlagsstring[]NoThe set of feature flags the integration will have access to.
namestringYesThe name value

svix_integrations_v1_operational_webhook_endpoint_create

Create Operational Webhook Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description value
disabledbooleanNoThe disabled value
filterTypesstring[]NoFilter Types
metadataobjectNoThe metadata value
rateLimitintegerNoDeprecated, use throttleRate instead.
secretstringNoThe endpoint’s verification secret. Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.
throttleRateintegerNoMaximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.
uidstringNoOptional unique identifier for the endpoint.
urlstringYesThe url value

svix_integrations_v1_operational_webhook_endpoint_delete

Delete Operational Webhook Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_integrations_v1_operational_webhook_endpoint_get

Get Operational Webhook Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_integrations_v1_operational_webhook_endpoint_get_headers

Get Operational Webhook Endpoint Headers Parameters:
ParameterTypeRequiredDefaultDescription
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_integrations_v1_operational_webhook_endpoint_get_secret

Get Operational Webhook Endpoint Secret Parameters:
ParameterTypeRequiredDefaultDescription
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_integrations_v1_operational_webhook_endpoint_list

List Operational Webhook Endpoints Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items

svix_integrations_v1_operational_webhook_endpoint_rotate_secret

Rotate Operational Webhook Endpoint Secret Parameters:
ParameterTypeRequiredDefaultDescription
endpoint_idstringYesThe Endpoint’s ID or UID.
keystringNoThe endpoint’s verification secret. Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

svix_integrations_v1_operational_webhook_endpoint_update

Update Operational Webhook Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
endpoint_idstringYesThe Endpoint’s ID or UID.
descriptionstringNoThe description value
disabledbooleanNoThe disabled value
filterTypesstring[]NoFilter Types
metadataobjectNoThe metadata value
rateLimitintegerNoDeprecated, use throttleRate instead.
throttleRateintegerNoMaximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.
uidstringNoOptional unique identifier for the endpoint.
urlstringYesThe url value

svix_integrations_v1_operational_webhook_endpoint_update_headers

Update Operational Webhook Endpoint Headers Parameters:
ParameterTypeRequiredDefaultDescription
endpoint_idstringYesThe Endpoint’s ID or UID.
headersobjectYesThe headers value