KOkombo
General

Trigger sync

Changed on

Trigger a sync for a specific integration.

<Warning>Please note that it is not necessary nor recommended to call this endpoint periodically on your side. Kombo already performs periodic syncs for you and you should only trigger syncs yourself in special cases (like when a user clicks on a "Sync" button in your app).</Warning>

post/force-sync

Request

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

type'FULL' | 'DELTA'

The type of the triggered sync.

Response

POST /force-sync Positive response

status'success' required

Example response

{
  "data": {
    "already_queued": false,
    "sync_id": "119ihtp91nA3dqRFiV67nXS6",
    "type": "DELTA"
  }
}

Changes

  • d0e06abf1118Revision changes
    • info

      added the new optional request property

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property const value success was added for the status

    • info

      removed the success enum value from the response property for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status