SVsvix
Connector

Create Connector

Changed on

Create a new connector.

post/api/v1/connector

Request

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

Headers

idempotency-keystring

The request's idempotency key

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 required
productType'Dispatch' | 'Stream'
transformationstring required
uidstring nullable

The Connector's UID.

Example request

{
  "allowedEventTypes": [
    "user.signup",
    "user.deleted"
  ],
  "description": "Example connector description",
  "instructions": "Markdown-formatted instructions",
  "logo": "https://example.com/logo.png",
  "name": "My first connector",
  "transformation": "function handler(webhook) { /* ... */ }",
  "uid": "unique-identifier"
}

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

  • cca56e67e5a4Revision 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

    • info

      added the required property to the response with the status

  • 6ef657cff5abRevision changes
    • warning

      added the new GrafanaCloudTracing enum value to the response property for the response status

    • warning

      added the new NewRelicTracing enum value to the response property for the response status

    • info

      added the new GrafanaCloudTracing enum value to the request property

    • info

      added the new NewRelicTracing enum value to the request property