Connectors

Connectors pull documents from external systems (Confluence, Google Drive, Slack, and more) into the Hadiq.io search index. All connector endpoints require admin or curator role. The connector stores the configuration for a data source. A connector-credential pair (CC pair) links a connector to a set of credentials and controls the sync schedule.

Create a connector

POST /api/manage/admin/connector

Creates a new connector. The connector is not immediately linked to credentials or indexed — use the CC pair endpoints for that.

Request body

string

required

Human-readable name for the connector.

string

required

The source type. Examples: confluence, google_drive, slack, github, web, file.

string

required

How documents are ingested: poll (periodic sync), event (webhook-driven), or load_state (one-time load).

object

required

Source-specific configuration. The required keys depend on the connector type. For example, a Confluence connector requires wiki_base, space, and optionally page_id.

string

required

Access control mode: public, private, or sync (inherit permissions from the source).

integer

Re-sync interval in seconds. Set to null for a one-time index with no automatic refresh.

integer

How often (in seconds) to prune deleted documents from the index. Optional.

string (ISO 8601)

Only index documents updated after this timestamp.

array

Group IDs that have access to documents from this connector (Enterprise Edition only).

Response

integer

Numeric ID of the newly created connector.

curl -X POST https://cloud.hadiq.io/api/manage/admin/connector \
  -H "Authorization: Bearer hadiqk-..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Engineering Confluence",
    "source": "confluence",
    "input_type": "poll",
    "connector_specific_config": {
      "wiki_base": "https://mycompany.atlassian.net/wiki",
      "space": "ENG"
    },
    "access_type": "public",
    "refresh_freq": 86400
  }'

import requests

resp = requests.post(
    "https://cloud.hadiq.io/api/manage/admin/connector",
    headers={"Authorization": "Bearer hadiqk-..."},
    json={
        "name": "Engineering Confluence",
        "source": "confluence",
        "input_type": "poll",
        "connector_specific_config": {
            "wiki_base": "https://mycompany.atlassian.net/wiki",
            "space": "ENG",
        },
        "access_type": "public",
        "refresh_freq": 86400,
    },
)
connector_id = resp.json()["id"]

List connectors

GET /api/manage/admin/connector

Returns all connectors visible to the authenticated user. System connectors are excluded from this list.

Query parameters

integer

Filter by a specific credential ID.

Response

An array of connector snapshots.

integer

Connector ID.

string

Connector name.

string

Source type.

string

Ingestion mode: poll, event, or load_state.

object

Source-specific configuration.

integer

Sync frequency in seconds, or null.

array

IDs of credentials linked to this connector.

string (ISO 8601)

Creation timestamp.

string (ISO 8601)

Last update timestamp.

curl https://cloud.hadiq.io/api/manage/admin/connector \
  -H "Authorization: Bearer hadiqk-..."

import requests

resp = requests.get(
    "https://cloud.hadiq.io/api/manage/admin/connector",
    headers={"Authorization": "Bearer hadiqk-..."},
)
for connector in resp.json():
    print(connector["id"], connector["name"], connector["source"])

Update a connector

PATCH /api/manage/admin/connector/{connector_id}

Updates connector configuration. Accepts the same fields as the create request.

Path parameters

integer

required

ID of the connector to update.

Request body

Same as create connector. All fields may be updated.

Response

Returns the updated ConnectorSnapshot.

curl -X PATCH https://cloud.hadiq.io/api/manage/admin/connector/42 \
  -H "Authorization: Bearer hadiqk-..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Engineering Confluence",
    "source": "confluence",
    "input_type": "poll",
    "connector_specific_config": {
      "wiki_base": "https://mycompany.atlassian.net/wiki",
      "space": "ENG"
    },
    "access_type": "public",
    "refresh_freq": 3600
  }'

import requests

resp = requests.patch(
    "https://cloud.hadiq.io/api/manage/admin/connector/42",
    headers={"Authorization": "Bearer hadiqk-..."},
    json={
        "name": "Engineering Confluence",
        "source": "confluence",
        "input_type": "poll",
        "connector_specific_config": {
            "wiki_base": "https://mycompany.atlassian.net/wiki",
            "space": "ENG",
        },
        "access_type": "public",
        "refresh_freq": 3600,
    },
)
print(resp.json())

Trigger a manual sync

POST /api/manage/admin/connector/run-once

Queues an immediate indexing run for a connector. Use this to sync changes without waiting for the scheduled refresh_freq.

Request body

integer

required

ID of the connector to sync.

array

Specific credential IDs to run for. If omitted, all credentials linked to the connector are used.

boolean

default:"false"

When true, re-indexes all documents from scratch rather than only new or changed ones.

Response

boolean

Whether the sync was successfully queued.

string

Confirmation message.

curl -X POST https://cloud.hadiq.io/api/manage/admin/connector/run-once \
  -H "Authorization: Bearer hadiqk-..." \
  -H "Content-Type: application/json" \
  -d '{
    "connector_id": 42,
    "from_beginning": false
  }'

import requests

resp = requests.post(
    "https://cloud.hadiq.io/api/manage/admin/connector/run-once",
    headers={"Authorization": "Bearer hadiqk-..."},
    json={"connector_id": 42, "from_beginning": False},
)
print(resp.json())

Get CC pair details

GET /api/manage/admin/cc-pair/{cc_pair_id}

Returns full details about a connector-credential pair, including indexing status, document counts, and sync history.

Path parameters

integer

required

The CC pair ID.

Response

integer

CC pair identifier.

string

Name of the CC pair.

string

Current status: active, paused, or deleting.

integer

Total documents currently in the index for this CC pair.

object

Embedded connector snapshot.

object

Embedded credential snapshot (sensitive fields masked).

string

Status of the most recent index attempt: success, failed, in_progress, or not_started.

string (ISO 8601)

Timestamp of the last successful sync.

boolean

Whether a sync is currently in progress.

string

public, private, or sync.

curl https://cloud.hadiq.io/api/manage/admin/cc-pair/7 \
  -H "Authorization: Bearer hadiqk-..."

import requests

resp = requests.get(
    "https://cloud.hadiq.io/api/manage/admin/cc-pair/7",
    headers={"Authorization": "Bearer hadiqk-..."},
)
pair = resp.json()
print(pair["name"], pair["status"], pair["num_docs_indexed"])

Pause or resume a CC pair

PUT /api/manage/admin/cc-pair/{cc_pair_id}/status

Sets the sync status of a connector-credential pair. Pausing stops all future indexing runs.

Path parameters

integer

required

The CC pair to update.

Request body

string

required

New status: active to resume, paused to pause.

curl -X PUT https://cloud.hadiq.io/api/manage/admin/cc-pair/7/status \
  -H "Authorization: Bearer hadiqk-..." \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'

curl -X PUT https://cloud.hadiq.io/api/manage/admin/cc-pair/7/status \
  -H "Authorization: Bearer hadiqk-..." \
  -H "Content-Type: application/json" \
  -d '{"status": "active"}'

import requests

requests.put(
    "https://cloud.hadiq.io/api/manage/admin/cc-pair/7/status",
    headers={"Authorization": "Bearer hadiqk-..."},
    json={"status": "paused"},
)

Error codes

Status	Cause
`400`	Invalid connector configuration or connector not deletable.
`403`	Insufficient permissions to manage the connector.
`404`	Connector or CC pair not found.

Overview

Endpoints

Create a connector

Request body

Response

List connectors

Query parameters

Response

Update a connector

Path parameters

Request body

Response

Trigger a manual sync

Request body

Response

Get CC pair details

Path parameters

Response

Pause or resume a CC pair

Path parameters

Request body

Error codes

​Create a connector

​Request body

​Response

​List connectors

​Query parameters

​Response

​Update a connector

​Path parameters

​Request body

​Response

​Trigger a manual sync

​Request body

​Response

​Get CC pair details

​Path parameters

​Response

​Pause or resume a CC pair

​Path parameters

​Request body

​Error codes

Create a connector

Request body

Response

List connectors

Query parameters

Response

Update a connector

Path parameters

Request body

Response

Trigger a manual sync

Request body

Response

Get CC pair details

Path parameters

Response

Pause or resume a CC pair

Path parameters

Request body

Error codes