Reference
Integrations
Connector manifests, config fields, and secrets with examples.
Integrations connect workspaces to systems. Operator flow in Connect data.
Connector manifests
| Field | Meaning |
|---|---|
| Name + version | What it is, which release — versions matter when behavior changes |
| Sync modes | Full refresh, incremental, or both — only declared modes are usable |
| Exactly-once | No duplicate delivery guaranteed or not — without it, identity keys carry the load |
| Discovery depth | Whether it enumerates tables/objects/streams for catalog browsing |
| Auth | OAuth-style delegation vs stored credentials |
{
"kind": "connector",
"name": "crm-prod",
"version": "2.4.0",
"supportedModes": ["full_refresh", "incremental"],
"features": { "exactlyOnce": false, "discover": { "deep": true }, "auth": { "oauth": true } }
}Image: connector catalog entry showing modes, discovery, and auth badges.
Configuration fields
| Type | Meaning | Example |
|---|---|---|
| String / number / integer / boolean | Plain settings, optional defaults | Host, port, batch size |
| Array / object | Nested settings | Table allow-lists, header maps |
| Enum | Fixed choices | Region selectors, API versions |
| Secret flag | Credential storage | Never shown outside the integration surface |
| Required + defaults | Must-fill vs ships-sensible | Aggressive defaults decide adoption |
{
"host": { "type": "string", "description": "Warehouse host", "required": ["host"] },
"port": { "type": "integer", "default": 5432 },
"password": { "type": "string", "secret": true },
"region": { "type": "string", "enum": ["eu-west", "us-east"] },
"tables": { "type": "array", "items": { "type": "string" } }
}The secret flag is a promise: anything marked secret never appears in workflows, previews, or shared views.
Selectors
Per-use narrowing — objects, filters, shape — distinct from installation settings. One source serves many workflows with different selectors.
Choosing well
- Match sync mode to schedule, discovery to how operators browse.
- Treat required-without-default as setup friction to justify or remove.