Skip to main content
Skip table of contents

Hightouch - Check Sync Status (Deprecated)

Overview

This Blueprint has been deprecated. Please use the vendor's "Trigger" Blueprint and set the "Wait for Completion" option to "True". Using this new option is free, more stable, and will complete faster. Read more about this change [here](https://www.shipyardapp.com/blog/orchestrate-data-tools-free). Check for the status of a Hightouch sync. The Vessel's exit code and status will match the status of the latest sync. ## Status Codes - If the sync finishes successfully, an exit code of 0 will be returned. - If the sync is finished but has errored, an exit code of 210 will be returned. - If the sync is incomplete, an exit code of 211 will be returned. The response for this request will always be stored at `shipyard-artifacts/hightouch-blueprints/responses/sync_run_{sync_run_id}_response.json`. **Recommended Setup:** 1. A Vessel built with this Blueprint should be paired with guardrail retries. This will allow the Vessel to continually check for status until a final result is found. 2. This Vessel should run immediately after a Vessel built with the Trigger Sync Blueprint. With this setup, you can leave the Sync Run ID field blank and this Vessel will check for the results of the recently created sync.

Variables

NameReferenceTypeRequiredDefaultOptionsDescription
API KeyHIGHTOUCH_API_KEYPasswordNone-The API Key associated with your Hightouch account.
Sync IDHIGHTOUCH_SYNC_IDAlphanumericNone-The ID of the Hightouch sync you want to refresh.
Sync Run IDHIGHTOUCH_SYNC_RUN_IDAlphanumericNone-The sync run ID that you want to check the status of. Leave blank if connected to another Vessel that will Trigger Sync.

YAML

Below is the YAML template

YAML

source:
  template: Hightouch - Check Sync Status (Deprecated)
  inputs:
    HIGHTOUCH_API_KEY:
    HIGHTOUCH_SYNC_ID:
    HIGHTOUCH_SYNC_RUN_ID:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200
    - 201
    - 210

      
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.