Create Input

Use this route to create a new input configuration. An input defines the tables and columns to be extracted from a data source.

How to use

Send the input details in the request body.

Payload example

{
  "tables": [
    {
      "name": "customers",
      "columns": ["id", "name", "email", "created_at"],
      "references": [
        {
          "name": "id",
          "type": "integer"
        }
      ],
      "identifier_columns": ["id"],
      "destination": {
        "raw": {
          "table_name": "TB__CUSTOMERS_RAW",
          "table_schema": "PUBLIC"
        },
        "qualify": {
          "table_name": "TB__CUSTOMERS",
          "table_schema": "PUBLIC"
        }
      },
      "type": "incremental"
    }
  ],
  "name": "Customer Data Input",
  "description": "Extracts customer data from the CRM",
  "plugin": "postgresql"
}

Body fields

• tables (required): array of table configurations, each containing:
  • name: the source table name;
  • columns: array of column names to extract;
  • references: array of column references with name and type;
  • identifier_columns: array of columns used as identifiers;
  • destination: mapping of destination tables for raw and qualify stages, each with table_name and table_schema;
  • type: replication type (e.g., incremental, full).
• name (required): display name for the input;
• description (required): description of the input;
• plugin (required): plugin identifier for the data source;
• type (optional): input type classification.

Error scenarios