Provider Connections

A Provider connection combines a Provider Plugin with the choices owned by one Workspace: its authentication strategy, credentials, connection-specific configuration, enabled data streams, and sync state. The plugin definition is shared across Workspaces. The connection is not.

Create a connection

Choose a Provider Plugin and grouping from the Provider Directory, then create the Workspace connection:

curl -X POST "https://api.parable.work/api/connectors" \
  -H "Authorization: Bearer $PARABLE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorId": "<provider-plugin-id>",
    "groupingId": "<grouping-id>",
    "authenticationStrategyId": "<authentication-strategy-id>",
    "authenticationConfig": {},
    "ingestionConfig": {}
  }'

Build authenticationConfig from the selected strategy’s configSchema. Build ingestionConfig from the plugin’s ingestionConfigSchema when one is present. The latter supplies connection-specific values such as an organization identifier or instance host; it does not redefine the plugin’s traversal or pagination behavior.

Read connection state

The instance reports computed fields such as connection status, credential validity, and recent sync state. Use the Provider Directory instance operations to list all connections or fetch one by ID.

Reconfigure or remove a connection

POST /api/connectors/configure replaces connection configuration or credentials using a supported authentication strategy.
DELETE /api/connectors/{tenantConnectorId} removes the Workspace’s connection.
The configuration-history operation shows prior configuration attempts without returning secret values.

See Provider authentication for credential handling and data streams for per-stream controls.

​Create a connection

​Read connection state

​Reconfigure or remove a connection

Create a connection

Read connection state

Reconfigure or remove a connection