Skip to main content
POST
/
force-sync
Python
from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.trigger_sync(type_="FULL")

    # Handle response
    print(res)
{
  "status": "success",
  "data": {
    "already_queued": false,
    "sync_id": "119ihtp91nA3dqRFiV67nXS6",
    "type": "DELTA"
  }
}
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).

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Body

application/json

POST /force-sync Request body

​
type
enum<string>
default:FULL

The type of the triggered sync.

Available options:
FULL,
DELTA

Response

POST /force-sync Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "already_queued": false,
  "sync_id": "119ihtp91nA3dqRFiV67nXS6",
  "type": "DELTA"
}