Skip to content

Sync job cron triggers Object

Properties

argsRecord<string, any>

The arguments passed to the sync job cron trigger.

Example: { "project_slug": "vcs_provider/org_name/repo_name" }
created_atstring · date-time

The date and time when the sync job run was created.

Example: 2021-08-10T10:00:00.000Z
cron_expressionstring

The cron expression defining when the sync job should run, in UTC.

Example: 0 0 * * *
daemon_group_keystring

The name of the daemon group that this sync job run should be assigned to. Used while creating a sync job run. Truto find a daemon in the group that is available to run the sync job. On runtime versions 1 to 3, specify exactly one of daemon_group_key (Daemon), webhook_id (RapidBridge) or super_query.

Example: default
environment_idstring · uuid

The environment the trigger belongs to.

error_handlingstring

The error_handling each run starts with. See the sync job run's error_handling.

Possible values:
fail_fastignorebatch
events_to_sendstring[]

When set, only these sync_job_run:* and record:* events are sent for the runs the trigger starts.

Possible values:
allintegrated_account:createdintegrated_account:updatedintegrated_account:deletedintegrated_account:activeintegrated_account:post_connect_form_submittedintegrated_account:post_install_errorintegrated_account:validation_errorintegrated_account:authentication_errorintegrated_account:forbidden_errorintegrated_account:reactivatedintegrated_account:stale+ 28 more
idstring · uuid

The ID of the sync job cron trigger.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7
individual_request_batch_sizenumber

Copied to each run the trigger starts. See the sync job run's individual_request_batch_size.

integrated_account_idstring · uuid

The ID of the integrated account that this sync job cron trigger should run.

Example: 94801e49-a652-42f9-af14-dd203d7897da
is_activeboolean

Whether the trigger is active. An inactive trigger is not scheduled, so it creates no sync job run and sends no webhook until it is made active again. New triggers are active unless created with is_active set to false.

Example: true
metaRecord<string, any>

Any JSON object, copied to each run the trigger starts.

super_querystring

Store the records of the runs the trigger starts in SuperQuery in this region. On runtime versions 1 to 3, specify exactly one of daemon_group_key (Daemon), webhook_id (RapidBridge) or super_query.

Possible values:
apacwnam
sync_job_idstring · uuid

The ID of the sync job that this sync job cron trigger should run.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7
updated_atstring · date-time

The date and time when the sync job run was last updated.

Example: 2021-08-10T10:00:00.000Z
webhook_idstring · uuid

The ID of the webhook where the sync job records need to be sent. On runtime versions 1 to 3, specify exactly one of daemon_group_key (Daemon), webhook_id (RapidBridge) or super_query.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7