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}"
}
Configure Connector
Activate resources for sync and set sync options.
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}"
}
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. |
{
"backfill": false,
"configured": 2,
"connector_id": "{connector_id}"
}
configured is the count of resources successfully activated.
Related Resources
- Next: Sync Connector - trigger an on-demand sync (the scheduler also runs hourly automatically)
- Next: Connector Resources - poll
provider_cursorto confirm sync ran - Discover Resources - find resource IDs before configuring
- Connectors - Overview
Authorizations
API key sent as a Bearer token: "Bearer prefix.secret"
Path Parameters
Connector ID
"HydraDoc1234"
Body
Resource selection and sync options
Resources to activate for this connector. Each item corresponds to one entry from the Discover endpoint.
Show child attributes
Show child attributes
[
{
"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"
}
]
Internal interval for async backfill paging.
86400
FullVisibilityRoles names the HubSpot roles whose members can see every record (PRO-2036). Resolved to ids against the portal at configure time and stored on the account-wide resource row. A pointer so an omitted field keeps the current setting while an explicit [] clears it.
How far back the first sync fetches historical data. Only applies to the initial sync — subsequent syncs are incremental from the last cursor.
30
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
Show child attributes
Response
OK
true
1
Connector this resource belongs to.
"conn_abc123"
FirstSyncAt/Message state the timing expectation: whether the first sync is already running (configure triggers one) or when the scheduled one runs, so clients stop inventing their own copy (PRO-1565).
Human-readable result message.
"Success"
Show child attributes
Show child attributes
Warnings names resources that were saved but produced nothing when probed. They are valid — the user may know a table is empty and expect it to fill — so they are not rejected, but they are the case that is otherwise indistinguishable from success at every layer, so they are never saved silently either.
Was this page helpful?