Configure Connector

curl -X POST 'https://api.hydradb.com/connectors/{connector_id}/configure' \
  -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
  -H "API-Version: 2" \
  -H "Content-Type: application/json" \
  -d '{
    "lookback_days": 30,
    "resources": [
      {
        "resource_id": "{resource_id}",
        "resource_type": "channel",
        "name": "general",
        "sub_tenant_id": "all-hands",
        "metadata": { "department": "all-hands" },
        "additional_metadata": { "internal_label": "general-slack" }
      },
      {
        "resource_id": "{resource_id_2}",
        "resource_type": "channel",
        "name": "engineering",
        "sub_tenant_id": "engineering",
        "metadata": { "department": "engineering" }
      }
    ]
  }'

{
  "backfill": false,
  "configured": 2,
  "connector_id": "{connector_id}"
}

POST

connectors

{id}

configure

curl -X POST 'https://api.hydradb.com/connectors/{connector_id}/configure' \
  -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
  -H "API-Version: 2" \
  -H "Content-Type: application/json" \
  -d '{
    "lookback_days": 30,
    "resources": [
      {
        "resource_id": "{resource_id}",
        "resource_type": "channel",
        "name": "general",
        "sub_tenant_id": "all-hands",
        "metadata": { "department": "all-hands" },
        "additional_metadata": { "internal_label": "general-slack" }
      },
      {
        "resource_id": "{resource_id_2}",
        "resource_type": "channel",
        "name": "engineering",
        "sub_tenant_id": "engineering",
        "metadata": { "department": "engineering" }
      }
    ]
  }'

{
  "backfill": false,
  "configured": 2,
  "connector_id": "{connector_id}"
}

Activates one or more resources and sets sync options. This is the step between discovery and the first sync. You can call configure again at any time to add resources, change sub_tenant_id, or update metadata - the cursor is preserved on reconfigure.

curl -X POST 'https://api.hydradb.com/connectors/{connector_id}/configure' \
  -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
  -H "API-Version: 2" \
  -H "Content-Type: application/json" \
  -d '{
    "lookback_days": 30,
    "resources": [
      {
        "resource_id": "{resource_id}",
        "resource_type": "channel",
        "name": "general",
        "sub_tenant_id": "all-hands",
        "metadata": { "department": "all-hands" },
        "additional_metadata": { "internal_label": "general-slack" }
      },
      {
        "resource_id": "{resource_id_2}",
        "resource_type": "channel",
        "name": "engineering",
        "sub_tenant_id": "engineering",
        "metadata": { "department": "engineering" }
      }
    ]
  }'

Path parameters

Name	Description
`id`	Connector UUID returned by `POST /connectors`.

Request body

Name	Description
	Resources to activate. Each item corresponds to one entry from Discover.
	How far back the first sync fetches historical data. Only applies to the initial sync - subsequent syncs are incremental from the last cursor. (default: `30`)

Resource item fields

Name	Description
	Resource identifier from `GET /connectors/:id/discover`.
	Resource type from `GET /connectors/:id/discover` (e.g. `channel`, `repo`, `linear_team`).
	Display name for this resource.
	Routes synced objects from this resource into a specific sub-tenant partition. Overrides the connector-level `sub_tenant_id`.
	Key-value pairs merged into tenant metadata on every synced object from this resource. Undeclared keys are accepted and stored, but only keys declared in `database_metadata_schema` are indexed for filtering.
	Key-value pairs merged into document metadata on every synced object from this resource. Free-form, no schema required.

See Connectors - Overview for how these merge with system-generated fields.

{
  "backfill": false,
  "configured": 2,
  "connector_id": "{connector_id}"
}

configured is the count of resources successfully activated.

Next: Sync Connector - trigger an on-demand sync (the scheduler also runs hourly automatically)
Next: Connector Resources - poll provider_cursor to confirm sync ran
Discover Resources - find resource IDs before configuring
Connectors - Overview

Authorizations

Authorization

string

header

required

API key sent as a Bearer token: "Bearer prefix.secret"

Path Parameters

string

required

Connector ID

Example:

"HydraDoc1234"

Body

application/json

Resource selection and sync options

resources

object[]

required

Resources to activate for this connector. Each item corresponds to one entry from the Discover endpoint.

Show child attributes

Example:

[
  {
    "additional_metadata": { "author": "ada", "doc_version": 3 },
    "collection": "team_docs",
    "database": "acme_corp",
    "metadata": { "department": "finance", "priority": 7 },
    "name": "general",
    "resource_id": "C0123456789",
    "resource_type": "channel"
  }
]

backfill_chunk_interval_seconds

integer

Internal interval for async backfill paging.

Example:

86400

lookback_days

integer

How far back the first sync fetches historical data. Only applies to the initial sync — subsequent syncs are incremental from the last cursor.

Example:

30

table_configs

object[]

TableConfigs carries per-table replication settings for MOVEIT connectors whose tap reads a table_configs credential input (bigquery). Configure merges them into the stored credential bundle before the first sync, so the mode chosen at selection time governs every sync from the start. Optional; rejected for non-MOVEIT engines.

Show child attributes

Response

backfill

boolean

Example:

true

configured

integer

Example:

1

connector_id

string

Connector this resource belongs to.

Example:

"conn_abc123"

API Documentation

Databases

Context

Query

Connectors

Webhooks

Miscellaneous

Path parameters

Request body

Resource item fields

Authorizations

Path Parameters

Body

Response

​Path parameters

​Request body

​Resource item fields

​Related Resources

Authorizations

Path Parameters

Body

Response

Path parameters

Request body

Resource item fields

Related Resources