Skip to main content
POST
createTenantConnectorTap

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Input for creating a per-workspace tap that narrows the schema of a platform tap (override case). The artifact-derived path is no longer accepted on this endpoint -- use the publishArtifact mutation instead. Supplying artifactId here is rejected server-side with USE_PUBLISH_ARTIFACT_INSTEAD and the field will be removed in a follow-up.

connectorTapId
string
required

UUID v4 with automatic base62 encoding for client-facing APIs

name
string
required

An objects name

outputSchema
object
required

A Parable Schema in JSON

tenantConnectorId
string
required

UUID v4 with automatic base62 encoding for client-facing APIs

artifactId
string

DEPRECATED: artifact-derived taps must be created via publishArtifact. Supplying this field is rejected with USE_PUBLISH_ARTIFACT_INSTEAD. The field will be removed in a follow-up; keep null in new clients.

canonicalPersonSource
boolean

Mark this tap as one of the Workspace's canonical person/identity sources. Any number of active taps may carry the designation; ordering among canonical sources is by tap creation time, earlier wins. Null = false.

config
object

A JSON object represented as a string

description
string
enabled
boolean

Response

Successful response

data
object
required

Per-workspace tap configuration. Either narrows a platform ConnectorTap's output schema for this workspace (override case) or stands in for an artifact-derived tap (artifact case). See EDR-0021 for the model.

meta
object
required