Sign in

v3

OpenAPI 3.1.02026-07-311255771.3 MB
General

Trigger sync

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

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"
  }
}