/svix-integrations | Type: Application | PCID required: Yes
Tools
svix_integrations_v1_connector_create
Create Connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allowedEventTypes | string[] | No | — | Allowed Event Types |
description | string | No | — | The description value |
featureFlags | string[] | No | — | Feature Flags |
instructions | string | No | — | The instructions value |
kind | string | No | — | The kind value |
logo | string | No | — | The logo value |
name | string | Yes | — | The name value |
productType | string | No | — | Product Type |
transformation | string | Yes | — | The transformation value |
uid | string | No | — | The Connector’s UID. |
svix_integrations_v1_connector_delete
Delete Connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connector_id | string | Yes | — | The Connector’s ID or UID. |
svix_integrations_v1_connector_get
Get Connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connector_id | string | Yes | — | The Connector’s ID or UID. |
svix_integrations_v1_connector_list
List Connectors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
product_type | string | No | — | Product Type |
svix_integrations_v1_connector_patch
Patch Connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connector_id | string | Yes | — | The Connector’s ID or UID. |
allowedEventTypes | string[] | No | — | Allowed Event Types |
description | string | No | — | The description value |
featureFlags | string[] | No | — | Feature Flags |
instructions | string | No | — | The instructions value |
kind | string | No | — | The kind value |
logo | string | No | — | The logo value |
name | string | No | — | The name value |
transformation | string | No | — | The transformation value |
svix_integrations_v1_connector_update
Update Connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connector_id | string | Yes | — | The Connector’s ID or UID. |
allowedEventTypes | string[] | No | — | Allowed Event Types |
description | string | No | — | The description value |
featureFlags | string[] | No | — | Feature Flags |
instructions | string | No | — | The instructions value |
kind | string | No | — | The kind value |
logo | string | No | — | The logo value |
name | string | No | — | The name value |
transformation | string | Yes | — | The transformation value |
svix_integrations_v1_integration_create
Create Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
featureFlags | string[] | No | — | The set of feature flags the integration will have access to. |
name | string | Yes | — | The name value |
svix_integrations_v1_integration_delete
Delete Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
integ_id | string | Yes | — | The Integration’s ID. |
svix_integrations_v1_integration_get
Get Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
integ_id | string | Yes | — | The Integration’s ID. |
svix_integrations_v1_integration_list
List Integrations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
svix_integrations_v1_integration_rotate_key
Rotate Integration Key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
integ_id | string | Yes | — | The Integration’s ID. |
svix_integrations_v1_integration_update
Update Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
integ_id | string | Yes | — | The Integration’s ID. |
featureFlags | string[] | No | — | The set of feature flags the integration will have access to. |
name | string | Yes | — | The name value |
svix_integrations_v1_operational_webhook_endpoint_create
Create Operational Webhook Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | The description value |
disabled | boolean | No | — | The disabled value |
filterTypes | string[] | No | — | Filter Types |
metadata | object | No | — | The metadata value |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
secret | string | No | — | The 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. |
throttleRate | integer | No | — | Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the endpoint. |
url | string | Yes | — | The url value |
svix_integrations_v1_operational_webhook_endpoint_delete
Delete Operational Webhook Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_integrations_v1_operational_webhook_endpoint_get
Get Operational Webhook Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_integrations_v1_operational_webhook_endpoint_get_headers
Get Operational Webhook Endpoint Headers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_integrations_v1_operational_webhook_endpoint_get_secret
Get Operational Webhook Endpoint Secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_integrations_v1_operational_webhook_endpoint_list
List Operational Webhook Endpoints Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
svix_integrations_v1_operational_webhook_endpoint_rotate_secret
Rotate Operational Webhook Endpoint Secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
key | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
description | string | No | — | The description value |
disabled | boolean | No | — | The disabled value |
filterTypes | string[] | No | — | Filter Types |
metadata | object | No | — | The metadata value |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the endpoint. |
url | string | Yes | — | The url value |
svix_integrations_v1_operational_webhook_endpoint_update_headers
Update Operational Webhook Endpoint Headers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
headers | object | Yes | — | The headers value |

