Skip to main content

ConnectorType

Object

Contains Connector type details.

type ConnectorType {
configSchema: JSONSchema
description: String
direction: ConnectorTypeConnectorDirection
id: String
metadata: [MetadataRecord]
name: String
runtimeVersion: ConnectorTypeRuntimeVersion
selfHostable: Boolean
taskQueue: String
version: String
webhookReceiveStorage: ConnectorTypeWebhookReceiveStorage
}

Fields​

FieldTypeDescription
configSchemaJSONSchemaThis is the JSON schema used to define how the config for a Connector needs to look.
descriptionStringThe description of the Connector type.
directionConnectorTypeConnectorDirectionReflects whether the Connector is SOURCE (ingress, data from the vendor to your org) or DESTINATION (egress, data from your org to an external destination like a data lake).
idStringThe unique ID of the Connector type.
metadata[MetadataRecord]
nameStringThe uneditable, assigned name of the Connector type; this is not the same as the Connector name defined by you when adding it to your org..
runtimeVersionConnectorTypeRuntimeVersion
selfHostableBoolean
taskQueueStringThis is an internal-only field; the value(s) included in this field may be requested by support for troubleshooting purposes, but otherwise holds no value for external developers.
versionStringThis identifies the version of the Connector setup in your org; Connectors may have multiple versions available.
webhookReceiveStorageConnectorTypeWebhookReceiveStorage

Used by​