Sync Status

Get the summary statistics of imports which can be used to determine if it's a good time to sync



gethttps://app.kindful.com/admin/oauth2/api/v1/imports/stats

COPY 
  Pending Jobs (200)

  {
    "sync_enabled": false,
    "message": "There are prior jobs queued up.  Sync could not be started",
    "pending_jobs": 5, // number of jobs (imports or links) that are queued up
    "pending_updates": 1 // number of record changes queued up
  }

  --

  Success Status (200)

  {
    "sync_enabled": true,
    "message": "ready",
    "pending_jobs": 0,
    "pending_updates": 0
  }

Usage

If you are performing a two-way sync between your app and Kindful:

  1. Check this status API to determine if sync can be initiated: sync_enabled: true.
  2. Query for transactions/query "unlinked"
  3. Send in links to acknowledge the records using Transaction Links.
  4. Page through results and call link per page of results.
  5. If syncing hourly then delay and go to step 1. If sync_enabled: false then delay further until sync_enabled: true

This will ensure that prior linking jobs are complete. It also allows an admin to pause the sync while they work through any issues that they find.



Import Status in the UI

In the UI, you can view the status of an import in the Connected Accounts section of Settings (URL = .../admin/connected_accounts)