Integrations
Trigger sync
Integrations
Trigger sync
Trigger a sync for a specific integration.
POST
/
force-sync
Authorization
Header
Body
curl --request POST \
--url https://api.kombo.dev/v1/force-sync \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '{}'{
"status": "success",
"data": {
"already_queued": false,
"sync_id": "119ihtp91nA3dqRFiV67nXS6"
}
}Please note that it is not necessary nor recommended to call this endpoint periodically on your side. Kombo already performs period 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
headerrequiredCreate an API key on the Secrets page in the Kombo dashboard.
Headers
X-Integration-Id
string
requiredID of the integration you want to interact with.
Body
application/json · object
The body is of type object.
Response
200 - application/json
status
enum<string>
requiredAvailable options:
success data
object
requiredcurl --request POST \
--url https://api.kombo.dev/v1/force-sync \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '{}'{
"status": "success",
"data": {
"already_queued": false,
"sync_id": "119ihtp91nA3dqRFiV67nXS6"
}
}