> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# svix-integrations

> Svix Integrations - manage integrations, connectors, operational webhooks

**Server path:** `/svix-integrations` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                                    | Description                                 |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [`svix_integrations_v1_connector_create`](#svix_integrations_v1_connector_create)                                                       | Create Connector                            |
| [`svix_integrations_v1_connector_delete`](#svix_integrations_v1_connector_delete)                                                       | Delete Connector                            |
| [`svix_integrations_v1_connector_get`](#svix_integrations_v1_connector_get)                                                             | Get Connector                               |
| [`svix_integrations_v1_connector_list`](#svix_integrations_v1_connector_list)                                                           | List Connectors                             |
| [`svix_integrations_v1_connector_patch`](#svix_integrations_v1_connector_patch)                                                         | Patch Connector                             |
| [`svix_integrations_v1_connector_update`](#svix_integrations_v1_connector_update)                                                       | Update Connector                            |
| [`svix_integrations_v1_integration_create`](#svix_integrations_v1_integration_create)                                                   | Create Integration                          |
| [`svix_integrations_v1_integration_delete`](#svix_integrations_v1_integration_delete)                                                   | Delete Integration                          |
| [`svix_integrations_v1_integration_get`](#svix_integrations_v1_integration_get)                                                         | Get Integration                             |
| [`svix_integrations_v1_integration_list`](#svix_integrations_v1_integration_list)                                                       | List Integrations                           |
| [`svix_integrations_v1_integration_rotate_key`](#svix_integrations_v1_integration_rotate_key)                                           | Rotate Integration Key                      |
| [`svix_integrations_v1_integration_update`](#svix_integrations_v1_integration_update)                                                   | Update Integration                          |
| [`svix_integrations_v1_operational_webhook_endpoint_create`](#svix_integrations_v1_operational_webhook_endpoint_create)                 | Create Operational Webhook Endpoint         |
| [`svix_integrations_v1_operational_webhook_endpoint_delete`](#svix_integrations_v1_operational_webhook_endpoint_delete)                 | Delete Operational Webhook Endpoint         |
| [`svix_integrations_v1_operational_webhook_endpoint_get`](#svix_integrations_v1_operational_webhook_endpoint_get)                       | Get Operational Webhook Endpoint            |
| [`svix_integrations_v1_operational_webhook_endpoint_get_headers`](#svix_integrations_v1_operational_webhook_endpoint_get_headers)       | Get Operational Webhook Endpoint Headers    |
| [`svix_integrations_v1_operational_webhook_endpoint_get_secret`](#svix_integrations_v1_operational_webhook_endpoint_get_secret)         | Get Operational Webhook Endpoint Secret     |
| [`svix_integrations_v1_operational_webhook_endpoint_list`](#svix_integrations_v1_operational_webhook_endpoint_list)                     | List Operational Webhook Endpoints          |
| [`svix_integrations_v1_operational_webhook_endpoint_rotate_secret`](#svix_integrations_v1_operational_webhook_endpoint_rotate_secret)   | Rotate Operational Webhook Endpoint Secret  |
| [`svix_integrations_v1_operational_webhook_endpoint_update`](#svix_integrations_v1_operational_webhook_endpoint_update)                 | Update Operational Webhook Endpoint         |
| [`svix_integrations_v1_operational_webhook_endpoint_update_headers`](#svix_integrations_v1_operational_webhook_endpoint_update_headers) | Update Operational Webhook Endpoint Headers |

***

## svix\_integrations\_v1\_connector\_create

Create Connector

**Parameters:**

| Parameter           | Type      | Required | Default | Description                   |                      |
| ------------------- | --------- | -------- | ------- | ----------------------------- | -------------------- |
| `idempotency-key`   | string    | No       | —       | The request's idempotency key |                      |
| `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    | null     | No      | —                             | The logo value       |
| `name`              | string    | Yes      | —       | The name value                |                      |
| `productType`       | string    | No       | —       | Product Type                  |                      |
| `transformation`    | string    | Yes      | —       | The transformation value      |                      |
| `uid`               | string    | null     | No      | —                             | The Connector's UID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "idempotency-key": {
        "type": "string",
        "description": "The request's idempotency key"
      },
      "allowedEventTypes": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Allowed Event Types"
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "featureFlags": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Feature Flags"
      },
      "instructions": {
        "type": "string",
        "description": "The instructions value"
      },
      "kind": {
        "type": "string",
        "description": "The kind value",
        "enum": [
          "Custom",
          "AgenticCommerceProtocol",
          "CloseCRM",
          "CustomerIO",
          "Discord",
          "Hubspot",
          "Inngest",
          "Loops",
          "Otel",
          "Resend",
          "Salesforce",
          "Segment",
          "Sendgrid",
          "Slack",
          "Teams",
          "TriggerDev",
          "Windmill",
          "Zapier"
        ]
      },
      "logo": {
        "type": [
          "string",
          "null"
        ],
        "description": "The logo value"
      },
      "name": {
        "type": "string",
        "description": "The name value"
      },
      "productType": {
        "type": "string",
        "description": "Product Type",
        "enum": [
          "Dispatch",
          "Stream"
        ]
      },
      "transformation": {
        "type": "string",
        "description": "The transformation value"
      },
      "uid": {
        "type": [
          "string",
          "null"
        ],
        "description": "The Connector's UID."
      }
    },
    "required": [
      "PCID",
      "name",
      "transformation"
    ]
  }
  ```
</Expandable>

***

## svix\_integrations\_v1\_connector\_delete

Delete Connector

**Parameters:**

| Parameter      | Type   | Required | Default | Description                |
| -------------- | ------ | -------- | ------- | -------------------------- |
| `connector_id` | string | Yes      | —       | The Connector's ID or UID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "connector_id": {
        "type": "string",
        "description": "The Connector's ID or UID."
      }
    },
    "required": [
      "PCID",
      "connector_id"
    ]
  }
  ```
</Expandable>

***

## svix\_integrations\_v1\_connector\_get

Get Connector

**Parameters:**

| Parameter      | Type   | Required | Default | Description                |
| -------------- | ------ | -------- | ------- | -------------------------- |
| `connector_id` | string | Yes      | —       | The Connector's ID or UID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "connector_id": {
        "type": "string",
        "description": "The Connector's ID or UID."
      }
    },
    "required": [
      "PCID",
      "connector_id"
    ]
  }
  ```
</Expandable>

***

## 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                                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "limit": {
        "type": "integer",
        "description": "Limit the number of returned items"
      },
      "iterator": {
        "type": "string",
        "description": "The iterator returned from a prior invocation"
      },
      "order": {
        "type": "string",
        "description": "The sorting order of the returned items",
        "enum": [
          "ascending",
          "descending"
        ]
      },
      "product_type": {
        "type": "string",
        "description": "Product Type",
        "enum": [
          "Dispatch",
          "Stream"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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    | null     | No      | —                          | The logo value |
| `name`              | string    | No       | —       | The name value             |                |
| `transformation`    | string    | No       | —       | The transformation value   |                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "connector_id": {
        "type": "string",
        "description": "The Connector's ID or UID."
      },
      "allowedEventTypes": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Allowed Event Types"
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "featureFlags": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Feature Flags"
      },
      "instructions": {
        "type": "string",
        "description": "The instructions value"
      },
      "kind": {
        "type": "string",
        "description": "The kind value",
        "enum": [
          "Custom",
          "AgenticCommerceProtocol",
          "CloseCRM",
          "CustomerIO",
          "Discord",
          "Hubspot",
          "Inngest",
          "Loops",
          "Otel",
          "Resend",
          "Salesforce",
          "Segment",
          "Sendgrid",
          "Slack",
          "Teams",
          "TriggerDev",
          "Windmill",
          "Zapier"
        ]
      },
      "logo": {
        "type": [
          "string",
          "null"
        ],
        "description": "The logo value"
      },
      "name": {
        "type": "string",
        "description": "The name value"
      },
      "transformation": {
        "type": "string",
        "description": "The transformation value"
      }
    },
    "required": [
      "PCID",
      "connector_id"
    ]
  }
  ```
</Expandable>

***

## 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    | null     | No      | —                          | The logo value |
| `name`              | string    | No       | —       | The name value             |                |
| `transformation`    | string    | Yes      | —       | The transformation value   |                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "connector_id": {
        "type": "string",
        "description": "The Connector's ID or UID."
      },
      "allowedEventTypes": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Allowed Event Types"
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "featureFlags": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Feature Flags"
      },
      "instructions": {
        "type": "string",
        "description": "The instructions value"
      },
      "kind": {
        "type": "string",
        "description": "The kind value",
        "enum": [
          "Custom",
          "AgenticCommerceProtocol",
          "CloseCRM",
          "CustomerIO",
          "Discord",
          "Hubspot",
          "Inngest",
          "Loops",
          "Otel",
          "Resend",
          "Salesforce",
          "Segment",
          "Sendgrid",
          "Slack",
          "Teams",
          "TriggerDev",
          "Windmill",
          "Zapier"
        ]
      },
      "logo": {
        "type": [
          "string",
          "null"
        ],
        "description": "The logo value"
      },
      "name": {
        "type": "string",
        "description": "The name value"
      },
      "transformation": {
        "type": "string",
        "description": "The transformation value"
      }
    },
    "required": [
      "PCID",
      "connector_id",
      "transformation"
    ]
  }
  ```
</Expandable>

***

## svix\_integrations\_v1\_integration\_create

Create Integration

**Parameters:**

| Parameter         | Type      | Required | Default | Description                                                   |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------- |
| `app_id`          | string    | Yes      | —       | The Application's ID or UID.                                  |
| `idempotency-key` | string    | No       | —       | The request's idempotency key                                 |
| `featureFlags`    | string\[] | No       | —       | The set of feature flags the integration will have access to. |
| `name`            | string    | Yes      | —       | The name value                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "app_id": {
        "type": "string",
        "description": "The Application's ID or UID."
      },
      "idempotency-key": {
        "type": "string",
        "description": "The request's idempotency key"
      },
      "featureFlags": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The set of feature flags the integration will have access to."
      },
      "name": {
        "type": "string",
        "description": "The name value"
      }
    },
    "required": [
      "PCID",
      "app_id",
      "name"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "app_id": {
        "type": "string",
        "description": "The Application's ID or UID."
      },
      "integ_id": {
        "type": "string",
        "description": "The Integration's ID."
      }
    },
    "required": [
      "PCID",
      "app_id",
      "integ_id"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "app_id": {
        "type": "string",
        "description": "The Application's ID or UID."
      },
      "integ_id": {
        "type": "string",
        "description": "The Integration's ID."
      }
    },
    "required": [
      "PCID",
      "app_id",
      "integ_id"
    ]
  }
  ```
</Expandable>

***

## 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       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "app_id": {
        "type": "string",
        "description": "The Application's ID or UID."
      },
      "limit": {
        "type": "integer",
        "description": "Limit the number of returned items"
      },
      "iterator": {
        "type": "string",
        "description": "The iterator returned from a prior invocation"
      },
      "order": {
        "type": "string",
        "description": "The sorting order of the returned items",
        "enum": [
          "ascending",
          "descending"
        ]
      }
    },
    "required": [
      "PCID",
      "app_id"
    ]
  }
  ```
</Expandable>

***

## 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.         |
| `idempotency-key` | string | No       | —       | The request's idempotency key |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "app_id": {
        "type": "string",
        "description": "The Application's ID or UID."
      },
      "integ_id": {
        "type": "string",
        "description": "The Integration's ID."
      },
      "idempotency-key": {
        "type": "string",
        "description": "The request's idempotency key"
      }
    },
    "required": [
      "PCID",
      "app_id",
      "integ_id"
    ]
  }
  ```
</Expandable>

***

## 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                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "app_id": {
        "type": "string",
        "description": "The Application's ID or UID."
      },
      "integ_id": {
        "type": "string",
        "description": "The Integration's ID."
      },
      "featureFlags": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The set of feature flags the integration will have access to."
      },
      "name": {
        "type": "string",
        "description": "The name value"
      }
    },
    "required": [
      "PCID",
      "app_id",
      "integ_id",
      "name"
    ]
  }
  ```
</Expandable>

***

## svix\_integrations\_v1\_operational\_webhook\_endpoint\_create

Create Operational Webhook Endpoint

**Parameters:**

| Parameter         | Type      | Required | Default | Description                   |                                                                                                                                                                                         |
| ----------------- | --------- | -------- | ------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `idempotency-key` | string    | No       | —       | The request's idempotency key |                                                                                                                                                                                         |
| `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   | null     | No      | —                             | Deprecated, use `throttleRate` instead.                                                                                                                                                 |
| `secret`          | string    | null     | 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   | null     | No      | —                             | Maximum messages per second to send to this endpoint.  Outgoing messages will be throttled to this rate.                                                                                |
| `uid`             | string    | null     | No      | —                             | Optional unique identifier for the endpoint.                                                                                                                                            |
| `url`             | string    | Yes      | —       | The url value                 |                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "idempotency-key": {
        "type": "string",
        "description": "The request's idempotency key"
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "disabled": {
        "type": "boolean",
        "description": "The disabled value"
      },
      "filterTypes": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Filter Types"
      },
      "metadata": {
        "type": "object",
        "description": "The metadata value"
      },
      "rateLimit": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Deprecated, use `throttleRate` instead."
      },
      "secret": {
        "type": [
          "string",
          "null"
        ],
        "description": "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": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Maximum messages per second to send to this endpoint.  Outgoing messages will be throttled to this rate."
      },
      "uid": {
        "type": [
          "string",
          "null"
        ],
        "description": "Optional unique identifier for the endpoint."
      },
      "url": {
        "type": "string",
        "description": "The url value"
      }
    },
    "required": [
      "PCID",
      "url"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "endpoint_id": {
        "type": "string",
        "description": "The Endpoint's ID or UID."
      }
    },
    "required": [
      "PCID",
      "endpoint_id"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "endpoint_id": {
        "type": "string",
        "description": "The Endpoint's ID or UID."
      }
    },
    "required": [
      "PCID",
      "endpoint_id"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "endpoint_id": {
        "type": "string",
        "description": "The Endpoint's ID or UID."
      }
    },
    "required": [
      "PCID",
      "endpoint_id"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "endpoint_id": {
        "type": "string",
        "description": "The Endpoint's ID or UID."
      }
    },
    "required": [
      "PCID",
      "endpoint_id"
    ]
  }
  ```
</Expandable>

***

## 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       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "limit": {
        "type": "integer",
        "description": "Limit the number of returned items"
      },
      "iterator": {
        "type": "string",
        "description": "The iterator returned from a prior invocation"
      },
      "order": {
        "type": "string",
        "description": "The sorting order of the returned items",
        "enum": [
          "ascending",
          "descending"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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.     |                                                                                                                                                                                         |
| `idempotency-key` | string | No       | —       | The request's idempotency key |                                                                                                                                                                                         |
| `key`             | string | null     | 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "endpoint_id": {
        "type": "string",
        "description": "The Endpoint's ID or UID."
      },
      "idempotency-key": {
        "type": "string",
        "description": "The request's idempotency key"
      },
      "key": {
        "type": [
          "string",
          "null"
        ],
        "description": "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."
      }
    },
    "required": [
      "PCID",
      "endpoint_id"
    ]
  }
  ```
</Expandable>

***

## 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   | null     | No      | —                         | Deprecated, use `throttleRate` instead.                                                                  |
| `throttleRate` | integer   | null     | No      | —                         | Maximum messages per second to send to this endpoint.  Outgoing messages will be throttled to this rate. |
| `uid`          | string    | null     | No      | —                         | Optional unique identifier for the endpoint.                                                             |
| `url`          | string    | Yes      | —       | The url value             |                                                                                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "endpoint_id": {
        "type": "string",
        "description": "The Endpoint's ID or UID."
      },
      "description": {
        "type": "string",
        "description": "The description value"
      },
      "disabled": {
        "type": "boolean",
        "description": "The disabled value"
      },
      "filterTypes": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Filter Types"
      },
      "metadata": {
        "type": "object",
        "description": "The metadata value"
      },
      "rateLimit": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Deprecated, use `throttleRate` instead."
      },
      "throttleRate": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Maximum messages per second to send to this endpoint.  Outgoing messages will be throttled to this rate."
      },
      "uid": {
        "type": [
          "string",
          "null"
        ],
        "description": "Optional unique identifier for the endpoint."
      },
      "url": {
        "type": "string",
        "description": "The url value"
      }
    },
    "required": [
      "PCID",
      "endpoint_id",
      "url"
    ]
  }
  ```
</Expandable>

***

## 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         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "endpoint_id": {
        "type": "string",
        "description": "The Endpoint's ID or UID."
      },
      "headers": {
        "type": "object",
        "description": "The headers value"
      }
    },
    "required": [
      "PCID",
      "endpoint_id",
      "headers"
    ]
  }
  ```
</Expandable>