503
error that looks like this:
503
response or listen to our sync-finished
webhook.
page_size
query param to the maximum batching (250 elements) to minimize number of API calls and maximize API response size.
statuses
filter to OPEN
The possible options here are OPEN
, CLOSED
, DRAFT
, ARCHIVED
next
key in our API response and passing it in the cursor
query paramremote_ids
,
job_codes
, name_contains
, post_url
. Here it is important to once again batch
requests. Instead of sending 20 individual requests containing one ID each, send
one request with comma-separated IDs.updated_after
query parameter, which you can use in the following way:
customer_id | kombo_integration_id | kombo_last_sync_started_at |
---|---|---|
<end_user.origin_id> | personio:8d1hpPsbjxUkoCoa1veLZGe5 | 1970-01-01T00:00:00.000Z |
<end_user.origin_id> | hibob:B1hu5NGyhdjSq5X3hxEz4bAN | 1970-01-01T01:13:24.000Z |
sync-finished
webhook that looks like this:
kombo_last_sync_started_at
for this specific integration and then pass it again in the updated_after
query param of the get endpoint, like this:
include_deleted
to true
so that you can be notified of jobs that were deleted. You can learn more about how to handle those jobs here.
status
property of a job)description
of a screening_question
related to a job)sync-finished
has a data.sync_state
property that is not "SUCCEEDED"
:
sync_state | Explanation | How to fix |
---|---|---|
SUCCEEDED | Everything went fine | |
PARTIALLY_FAILED | Succeeded but had non-fatal errors | Kombo will take care of it |
sync_state | Explanation | How to fix |
---|---|---|
CANCELLED | The sync was actively canceled by Kombo | This happens very rarely, has no negative side-effects, and if it does happen, we will schedule a new sync shortly after |
FAILED | There was a critical error during the sync and the sync did not finish. | If this happens, we get an alert and will look into the issue to fix it ASAP |
TIMED_OUT | The sync timed out before completion | This happens rarely and will cause an immediate and automatic restart of the sync. Kombo will be notified and look into the issue ASAP |
sync_state | Explanation | How to fix |
---|---|---|
AUTHENTICATION_FAILED | The sync couldn’t complete because the API credentials are invalid or don’t allow requesting all data points in your scope | This can only be fixed by your customer adding additional permissions to the credentials or updating the credentials altogether |
id | title | customer_id | kombo_job_id |
---|---|---|---|
3WA6SZ7R7YSo2C3WDLE5zmAJ | Senior integration engineer | <end_user.origin_id> | 21KvMGS9Yhsbbsxfwqyb5dkF |
FhsTj1impXjFGzdG6QZuDnaW | Customer success manager | <end_user.origin_id> | WA6SZ7R7YSo2C3WDLE5zmAJ |
ARCHIVED
or CLOSED
.
Some ATS’s allow the complete deletion of jobs, in which case we will stop receiving that job on the ATS API. When that happens we set the remote_deleted_at
timestamp for that record to let you know that this entry does not exist anymore. We will, however, not update the job status to be CLOSED
. After 14 days we will completely remove the record from our system.
By default, we will exclude deleted jobs from our API response, so that you don’t ingest any deleted records into your system. To get notified about deleted entries you can set the query param ?include_deleted=true
. If you don’t do this, your applications will most likely fail because it’s not possible to apply for a deleted job.