Skip to main content
Skip table of contents

Census - Trigger Sync

Overview

Immediately execute a Census snyc. The sync must already be set up within the Census 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/census-blueprints/variables/sync_run_id.pickle` **Recommended Setup:** The Census Sync being triggered should not have any other schedules set in the Census UI to avoid conflicting runs.

Variables

NameReferenceTypeRequiredDefaultOptionsDescription
API KeyCENSUS_API_KEYPasswordNone-The API Key associated with your Census account.
Sync IDCENSUS_SYNC_IDAlphanumericNone-The ID of the Census sync you want to refresh.
Wait For CompletionCENSUS_WAITBooleanTRUE-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

YAML

source:
  template: Census - Trigger Sync
  inputs:
    CENSUS_API_KEY:
    CENSUS_SYNC_ID:
    CENSUS_WAIT: 'TRUE'
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200

      
JavaScript errors detected

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

If this problem persists, please contact our support.