ELT Syncs

Add source streams to ELT sync

Changed on

Add source streams to the given ELT sync and return the newly created streams. This method will only add new streams and update existing streams

post/elt_syncs/{id}/source_streams

Request

  • Base URL
    https://connect.weld.app
  • URL
    https://connect.weld.app/elt_syncs/{id}/source_streams
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:X4ughggABSd3UY

The ID of the ELT sync.

Request body

Example request

{
  "source_streams": [
    {
      "additional_incremental_pointer_ids": [
        "closed_at"
      ],
      "primary_keys": [
        "id"
      ],
      "excluded_substreams": [
        "substream1",
        "substream2"
      ],
      "full_sync_schedule": "0 3 * * 0"
    }
  ]
}

Response

The source streams have been successfully added.

Example response

{
  "source_streams": [
    {
      "id": "SCTVdLAcyDTgNx",
      "elt_sync_id": "3LIw2FdxoByya9",
      "name": "users",
      "incremental_primary_key_name": [
        "id"
      ],
      "primary_keys": [
        "id"
      ],
      "excluded_columns": [
        "email"
      ],
      "hashed_columns": [
        "phone"
      ],
      "incremental_pointer_id": "updated_at",
      "additional_incremental_pointer_ids": [
        "closed_at"
      ],
      "created_at": "2020-01-01T00:00:00.000Z",
      "updated_at": "2020-01-01T00:00:00.000Z",
      "excluded_substreams": [
        "substream1",
        "substream2"
      ],
      "sync_interval": "0 0 * * *",
      "full_sync_schedule": "0 3 * * 0"
    }
  ]
}

Changes

    • info

      added the new optional request property //

    • info

      added the required property // to the response with the status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status