RudderStack - Trigger Sync

info

This Blueprint is classified as "Free" and does not incur billable runtime. Learn more.

Overview

Immediately execute a sync of a Rudderstack source. This can kick off either an ETL or a reverse ETL job. The source must already be set up within the Rudderstack interface.

If a sync is already running for the specified connector, it will be stopped and restarted.

This Blueprint will create and store the source ID used to shipyard-artifacts/rudderstack-blueprints/variables/source_id.pickle

Variables

Name	Reference	Type	Required	Default	Options	Description
Access Token	RUDDERSTACK_ACCESS_TOKEN	Password	✅	-	-	The access token associated with your Rudderstack account.
Source ID	RUDDERSTACK_SOURCE_ID	Alphanumeric	✅	-	-	The ID of the Rudderstack source you want to refresh.
Wait For Completion	RUDDERSTACK_WAIT	Boolean	➖	TRUE	-	Enable if you want the vessel to wait until the sync job is successfully completed. Otherwise, the vessel will only initiate the sync job without waiting

YAML

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: RudderStack - Trigger Sync
  inputs:
    RUDDERSTACK_ACCESS_TOKEN: null  ## REQUIRED
    RUDDERSTACK_SOURCE_ID: null ## REQUIRED
    RUDDERSTACK_WAIT: 'TRUE'
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '200'
    - '203'
    - '204'