Sync - Terminal

string<ulid>

required

Pattern: ^sync_[0-9A-HJKMNP-TV-Z]{26}$

Example:

"sync_01GV12VR4DJP70GD1ZBK0SDWFH"

status

enum<string>

required

The status of the sync

Available options:

requested,

in_progress,

completed,

failed

Example:

"completed"

requestedAt

string<date-time>

required

ISO 8601 date

Example:

"2021-01-06T03:24:53.000Z"

failureReason

string

If the sync failed, this will contain the reason

Example:

"Reason for failure if sync status is 'failed'"

progress

number

Percentage value between 0 and 100, rounded to 2 decimal places.

Required range: 0 <= x <= 100

Example:

85

issues

(string<ulid> | ExpandableIssue · object)[]

Issues are problems encountered with a connection that did not result in a failed sync but may require manual intervention. You can see the issues for a given sync by providing issues to the expand parameter.

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

Pattern: ^isu_[0-9A-HJKMNP-TV-Z]{26}$

Example:

"isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"

startFrom

string<date-time>

ISO 8601 date

Example:

"2021-01-06T03:24:53.000Z"

completedAt

string<date-time>

ISO 8601 date

Example:

"2021-01-06T03:24:53.000Z"

attempts

number

Example:

1

providerRequests

enum<string>[]

Provider requests attached to this sync. When non-empty, the sync is waiting on an out-of-band step on the provider's side (e.g. the provider manually delivering historical files, or credentials being provisioned) and may legitimately stay in progress for an extended period.

Available options:

historical_files,

provision_credentials

Example:

["historical_files"]