WEweld
Reverse ETL Syncs

Create Reverse ETL Sync

Changed on

Create a Reverse ETL Sync that reads from a source Transform and writes to a destination connection. The sync is activated immediately so it runs on its schedule (or as part of its Orchestration Workflow). The settings are validated against the settings schema (see the "Get Reverse ETL Settings Schema for a connection" endpoint).

post/reverse_etl_syncs

Request

  • Base URL
    https://connect.weld.app
  • URL
    https://connect.weld.app/reverse_etl_syncs
  • Auth
    API key in header x-api-key

Request body

destination_connection_idstring required

The ID of the (already created) destination connection the Reverse ETL Sync writes to.

source_idstring required

The ID of the source Transform the Reverse ETL Sync reads from.

object_type_idstring required

The opaque ID of the destination object type to write to (as returned by the object types endpoint).

sync_intervalstring cron expression

The cron expression defining when the sync runs. Required unless the sync is attached to an Orchestration Workflow via orchestration_workflow_id.

orchestration_workflow_idstring

The ID of the Orchestration Workflow to attach the sync to. When provided, the sync runs as part of the Orchestration instead of on its own sync_interval.

settingsobject

The destination settings for the sync, validated against the settings schema (see the "Get Reverse ETL Settings Schema for a connection" endpoint).

Example request

{
  "destination_connection_id": "X4ughggABSd3UY",
  "source_id": "OoORhGXUVjsqFG",
  "object_type_id": "Q29udGFjdHx8Y29udGFjdA",
  "operation": {
    "mode": "insert",
    "mappings": [
      {
        "source_property_id": "email",
        "destination_property_id": "email",
        "primary_key": true
      }
    ]
  },
  "sync_interval": "0 0 * * *",
  "orchestration_workflow_id": "3LIw2FdxoByya9",
  "settings": {
    "listId": "12345",
    "sheetId": "abc123"
  }
}

Response

idstring required

The Id of the Reverse ETL Sync.

enabledboolean required

Whether the Reverse ETL Sync is enabled and running on its schedule.

source_type'RawView' | 'Transform' required

The type of the source the Reverse ETL Sync reads from.

source_idstring required

The Id of the source (Transform or Raw View) the Reverse ETL Sync reads from.

transform_idstring

The Id of the Transform the Reverse ETL Sync reads from, if the source is a Transform.

destination_connection_idstring required

The Id of the Destination Connection.

destination_integration_idstring required

The Id of the Destination Integration.

object_type_idstring required

The Id of the object in the destination that the Reverse ETL Sync writes to.

sync_intervalstring cron expression

The cron expression when the sync should run. Provided if the sync is not attached to an Orchestration.

orchestration_workflow_idstring

The Id of the Orchestration Workflow that the sync is attached to.

created_atstring date-time required

The datetime when the Reverse ETL Sync was created.

updated_atstring date-time required

The datetime when the Reverse ETL Sync was last updated.

settingsobject required

The settings for the Reverse ETL Sync, provided when creating/updating the sync.

Example response

{
  "id": "OoORhGXUVjsqFG",
  "enabled": true,
  "source_type": "Transform",
  "source_id": "mdl_123",
  "transform_id": "mdl_123",
  "destination_connection_id": "conn_456",
  "destination_integration_id": "hubspot",
  "object_type_id": "Q29udGFjdHx8Y29udGFjdA",
  "sync_interval": "0 0 * * *",
  "orchestration_workflow_id": "3LIw2FdxoByya9",
  "operation": {
    "mode": "upsert",
    "mappings": [
      {
        "source_property_id": "email",
        "destination_property_id": "email",
        "primary_key": true
      }
    ]
  },
  "created_at": "2020-01-01T00:00:00.000Z",
  "updated_at": "2020-01-01T00:00:00.000Z",
  "settings": {
    "listId": "12345",
    "sheetId": "abc123"
  }
}

Changes