SVsvix
Connector

Patch Connector

Changed on

Partially update a connector.

patch/api/v1/connector/{connector_id}

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/connector/{connector_id}
  • Auth
    HTTP bearer

Path parameters

connector_idstring required

The Connector's ID or UID.

Example:unique-identifier

Request body

allowedEventTypesstring[] nullable
descriptionstring
featureFlagsstring[] nullable
instructionsstring
kind'Custom' | 'AgenticCommerceProtocol' | 'CloseCRM' | 'CustomerIO' | 'DatadogTracing' | 'Discord' | 'GrafanaCloudTracing' | 'Hubspot' | 'Inngest' | 'Loops' | 'NewRelicTracing' | 'Otel' | 'Resend' | 'Salesforce' | 'Segment' | 'Sendgrid' | 'Slack' | 'Teams' | 'TriggerDev' | 'Windmill' | 'Zapier'
logostring uri nullable
namestring
transformationstring

Example request

{
  "allowedEventTypes": [
    "user.signup",
    "user.deleted"
  ],
  "featureFlags": [
    "cool-new-feature"
  ]
}

Response

allowedEventTypesstring[] nullable
createdAtstring date-time required
descriptionstring required
featureFlagsstring[] nullable
idstring required

The Connector's ID.

instructionsstring required
kind'Custom' | 'AgenticCommerceProtocol' | 'CloseCRM' | 'CustomerIO' | 'DatadogTracing' | 'Discord' | 'GrafanaCloudTracing' | 'Hubspot' | 'Inngest' | 'Loops' | 'NewRelicTracing' | 'Otel' | 'Resend' | 'Salesforce' | 'Segment' | 'Sendgrid' | 'Slack' | 'Teams' | 'TriggerDev' | 'Windmill' | 'Zapier' required
logostring uri nullable
namestring required
orgIdstring required

The Environment's ID.

productType'Dispatch' | 'Stream' required
transformationstring required
transformationUpdatedAtstring date-time required
uidstring nullable

The Connector's UID.

updatedAtstring date-time required

Example response

{
  "allowedEventTypes": [
    "user.signup",
    "user.deleted"
  ],
  "featureFlags": [
    "cool-new-feature"
  ],
  "id": "trtmpl_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "orgId": "org_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "uid": "unique-identifier"
}

Changes

  • 21bb0f86a732Revision changes
    • warning

      the request property's maxLength was set to 4096

    • warning

      the request property's maxLength was set to 4096

    • warning

      the request property's maxLength was set to 512

  • cca56e67e5a4Revision changes
    • info

      added the required property to the response with the status