Connectors API

Connector Discovery

GET /api/connectors/sources

List available source connectors from bizon-core.

[
  {
    "name": "hubspot",
    "display_name": "HubSpot",
    "description": "HubSpot CRM data source",
    "streams": ["contacts", "companies", "deals", "tickets"],
    "auth_types": ["api_key", "oauth"],
    "example_config": {
      "authentication": {
        "type": "api_key",
        "params": { "token": "your-token" }
      }
    }
  },
  {
    "name": "kafka",
    "display_name": "Apache Kafka",
    "streams": ["dynamic"],
    "auth_types": ["sasl_plain", "sasl_ssl"]
  }
]

GET /api/connectors/destinations

List available destination connectors.

[
  {
    "name": "bigquery",
    "display_name": "Google BigQuery",
    "description": "Google BigQuery data warehouse",
    "example_config": {
      "project_id": "your-project",
      "dataset": "your_dataset"
    }
  },
  {
    "name": "logger",
    "display_name": "Logger",
    "description": "Log records to console (for testing)"
  }
]

Saved Source Connectors

Saved connectors store reusable configurations with encrypted credentials.

POST /api/saved/sources

Create a saved source connector.

Request

{
  "name": "Production HubSpot",
  "connector_name": "hubspot",
  "config": {
    "authentication": {
      "type": "api_key",
      "params": { "token": "pat-xxx" }
    }
  },
  "description": "HubSpot production account"
}

Response

{
  "id": "uuid",
  "name": "Production HubSpot",
  "type": "source",
  "connector_name": "hubspot",
  "description": "HubSpot production account",
  "created_at": "2024-01-15T10:00:00Z"
}

GET /api/saved/sources

List saved source connectors.

[
  {
    "id": "uuid",
    "name": "Production HubSpot",
    "type": "source",
    "connector_name": "hubspot",
    "description": "HubSpot production account",
    "created_at": "2024-01-15T10:00:00Z"
  }
]

GET /api/saved/sources/{id}

Get saved source with full config.

{
  "id": "uuid",
  "name": "Production HubSpot",
  "type": "source",
  "connector_name": "hubspot",
  "config": {
    "authentication": {
      "type": "api_key",
      "params": { "token": "pat-xxx" }
    }
  },
  "description": "HubSpot production account",
  "created_at": "2024-01-15T10:00:00Z"
}

PUT /api/saved/sources/{id}

Update a saved source connector.

{
  "name": "HubSpot Production (Updated)",
  "config": {
    "authentication": {
      "type": "api_key",
      "params": { "token": "new-token" }
    }
  }
}

DELETE /api/saved/sources/{id}

Delete a saved source connector.

Returns 204 No Content.

Saved Destination Connectors

POST /api/saved/destinations

Create a saved destination connector.

{
  "name": "Production BigQuery",
  "connector_name": "bigquery",
  "config": {
    "project_id": "my-project",
    "dataset": "production_data",
    "credentials_base64": "..."
  },
  "description": "Production data warehouse"
}

GET /api/saved/destinations

List saved destination connectors.

GET /api/saved/destinations/{id}

Get saved destination with full config.

PUT /api/saved/destinations/{id}

Update a saved destination connector.

DELETE /api/saved/destinations/{id}

Delete a saved destination connector.

Returns 204 No Content.

Using Saved Connectors in Pipelines

Reference saved connectors by ID when creating pipelines:

{
  "name": "HubSpot to BigQuery",
  "config": {
    "source": {
      "saved_connector_id": "source-uuid",
      "stream": "contacts"
    },
    "destination": {
      "saved_connector_id": "destination-uuid"
    }
  }
}