List sync job cron triggers

You can use this endpoint to list all the sync job cron triggers that have been created for your Truto account.

Endpoint

http

GET /sync-job-cron-trigger

Response Body

results

object[]

string · uuid

The ID of the sync job cron trigger.

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

args

object

The arguments passed to the sync job cron trigger.

Example:

{
  "project_slug": "vcs_provider/org_name/repo_name"
}

resources

object[]

The resources to sync as part of the sync job.

resource

string

REQUIRED ·

The name of the resource to sync. For Unified APIs, it should be in the format unified_api_name/resource_name. For Proxy API, it can just be resource_name.

Example: For fetching Contacts from CRM Unified API, `crm/contacts`. For fetching Contacts from a Proxy API, `contacts`.

method

string

REQUIRED ·

The method to call on the resource.

Example: list

string

The ID of the resource to sync. This is optional and can be used to sync a single resource. It also supports placeholders.

Example: Static value like `4a4de828-f4db-4c9e-adfd-434e0864c3c7` or placeholder like `{{args.user_id}}`.

query

object

The query parameters to pass to the resource method. It supports placeholders for values.

Example:

{
  "page": 1,
  "per_page": 100,
  "user_id": "{{args.user_id}}"
}

loop_on

string

When a particular placeholder argument is an array and you want to repeat the request for each element in that array, you can set this parameter. For example, if you accept an argument called user_ids which is an array of strings, and you want to fetch each user's details, you can set this parameter to user_ids and the request will be repeated for each element in the user_ids array.

Example:

{
  "{ args.user_ids }": null
}

depends_on

string

The resource that this resource depends on (parent resource). This is optional and can be used to sync a resource only after another resource has been synced. Each object synced for the parent resource is available as the resources object in placeholders for the child resource, e.g. {{resources.crm.contacts.id}} if depends on is crm/contacts resource.

Example: crm/contacts

persist

boolean

Whether to persist the resource in the database or not in case of a Daemon sync job run or send as a payload in case of RapidBridge sync job run. The Proxy API resources are by default NOT persisted and this parameter can be set to true to persist them. Unified API resources are always persisted.

cron_expression

string

The cron expression defining when the sync job should run.

Example: 0 0 * * *

sync_job_id

string · uuid

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

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

integrated_account_id

string · uuid

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

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

daemon_group_key

string

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. You can either specify daemon_group_key (Daemon) or webhook_id (RapidBridge), but NOT both while creating a Sync Job Run.

Example: default

webhook_id

string · uuid

The ID of the webhook where the sync job records need to be sent. You can either specify daemon_group_key (Daemon) or webhook_id (RapidBridge), but NOT both while creating a Sync Job Run.

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

created_at

string · date-time

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

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

updated_at

string · date-time

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

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

next_cursor

string

limit

number