v1

latestOpenAPI 3.1.0Proprietary2026-07-262570100.1 KB

connectors

Create a connector resource

Add a resource mapping to a connector.

post/connectors/{id}/resources

Path parameters

idstring required

Example:HydraDoc1234

Connector ID

Request body

additional_metadataobject

Key-value pairs merged into document metadata on every synced object from this resource.

collection_overridestring

database_overridestring

display_namestring

Human-readable name for this resource.

filtersobject

Provider-specific filters applied during sync (e.g. {"lookback_days": 30}).

metadataobject

Key-value pairs merged into tenant metadata on every synced object from this resource.

provider_metadataobject

Additional provider-supplied metadata for this resource.

resource_idstring required

Resource identifier from the Discover endpoint.

resource_typestring

Type of resource within the provider (e.g. channel, repo, linear_team).

sub_tenant_id_overridestring

deprecated: use collection_override

tenant_id_overridestring

DatabaseOverride/CollectionOverride are the canonical v2 names; TenantIDOverride/SubTenantIDOverride are their deprecated aliases.

Example request

{
  "additional_metadata": {
    "author": "ada",
    "doc_version": 3
  },
  "display_name": "general",
  "filters": {
    "channel": "general"
  },
  "metadata": {
    "department": "finance",
    "priority": 7
  },
  "provider_metadata": {
    "workspace_id": "T12345ACME"
  },
  "resource_id": "C0123456789",
  "resource_type": "channel"
}

Response

Created

additional_metadataobject

AdditionalMetadata is merged into the additional_metadata (document metadata) layer of every object synced from this resource. User-supplied keys are shallow-merged as the base; provider-generated fields are applied on top and always win on conflict.

backfill_chunk_interval_secondsinteger

BackfillChunkIntervalSeconds is the pacing interval persisted at configure time so the scheduler can thread it into each chunk's workflow input.

backfill_next_chunk_atstring

BackfillNextChunkAt is the RFC3339 time the next chunk becomes due. The backfill workflow processes one chunk then sets this to now+interval and exits; the connector scheduler starts the next chunk once it passes.

backfill_oldeststring

BackfillOldest is an RFC3339 timestamp marking the oldest boundary remaining for async historical backfill. Empty means backfill is complete or not needed.

backfill_statusstring

BackfillStatus gates the sparse ResourcesByBackfillNextChunkAt GSI: it is set to BackfillStatusActive while a historical backfill is in progress and removed when it completes, so only actively-backfilling resources appear in the scheduler's due query. Pacing between chunks is driven by that scheduler (see BackfillNextChunkAt), not by an in-workflow sleep.

collection_overridestring

Routes this resource's synced objects into a specific collection, overriding the connector's. Canonical name; mirrors the deprecated sub_tenant_id_override alias.

connector_idstring

Connector this resource belongs to.

database_overridestring

DatabaseOverride/CollectionOverride are the canonical v2 names for the deprecated tenant_id_override/sub_tenant_id_override wire fields. Empty means the resource inherits the connector's database/collection, exactly as the deprecated fields do. Not persisted (dynamodbav:"-"): mirrored from the tenant_id_override/sub_tenant_id_override values at construction time.

display_namestring

Human-readable name for this resource.

filtersobject

Provider-specific filters applied during sync (e.g. {"lookback_days": 30}).

metadataobject

Metadata is merged into the tenant metadata layer of every object synced from this resource. User-supplied keys are shallow-merged as the base; system defaults (connector_id, provider) are applied on top so they always win on conflict — user keys extend the map but cannot override system-set fields.

provider_cursorstring

Bookmark of the last synced position. Non-empty value confirms the first sync has run.

provider_metadataobject

Additional provider-supplied metadata for this resource.

resource_idstring

Resource identifier from the Discover endpoint.

resource_typestring

Type of resource within the provider (e.g. channel, repo, linear_team).

statusstring

Current sync state of this resource (e.g. active, paused).

sub_tenant_id_overridestring

Overrides the connector-level collection for objects synced from this resource.

tenant_id_overridestring

Overrides the connector-level database for objects synced from this resource. Deprecated.

Example response

{
  "additional_metadata": {
    "author": "ada",
    "doc_version": 3
  },
  "backfill_chunk_interval_seconds": 86400,
  "backfill_oldest": "2026-06-01T00:00:00Z",
  "connector_id": "conn_abc123",
  "display_name": "general",
  "filters": {
    "channel": "general"
  },
  "metadata": {
    "department": "finance",
    "priority": 7
  },
  "provider_cursor": "1699999999.000100",
  "provider_metadata": {
    "workspace_id": "T12345ACME"
  },
  "resource_id": "C0123456789",
  "resource_type": "channel",
  "status": "completed"
}