Skip to main content
POST
/
connect
/
create-link
Python
from kombo import Kombo


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

    res = k_client.connect.create_connection_link(end_user_email="[email protected]", end_user_organization_name="Test Inc.", end_user_origin_id="123", integration_category="HRIS", integration_tool="personio", language="en", enable_filtering=False, enable_field_mapping=False, link_type="EMBEDDED")

    # Handle response
    print(res)
{
  "status": "success",
  "data": {
    "link": "https://connect.kombo.dev/v1?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.SWYgeW91IGFyZSByZWFkaW5nIHRoaXMsIHdlIHdvdWxkIGxpa2UgdG8gbGV0IHlvdSBrbm93IHRoYXQgd2UgYXJlIGhpcmluZyBwZW9wbGUgbGlrZSB5b3UgOikuIFJlYWNoIG91dCB0byBhbGV4QGtvbWJvLmRldiB0byBnZXQgaW4gY29udGFjdCBhbmQgdGVsbCBoaW0geW91IGNvbWUgZnJvbSB0aGUgSldUIDsp._hhX5YTtHfLn9ZC806dZceRn2whzxHyrhft1ONzNgOE"
  }
}
Check out our full guide for more details about implementing the connection flow into your app.
Kombo will not deduplicate integrations for you that are created with this endpoint. You are responsible for keeping track of integrations in your system and prevent customers from connecting the same tool again. Use the reconnection link endpoint if you want a customer to update their credentials.

​
Example Request Body

{
  "end_user_email": "[email protected]",
  "end_user_organization_name": "Test Inc.",
  "integration_category": "HRIS",
  "integration_tool": "personio",
  "end_user_origin_id": "123",
  "language": "en",
  "link_type": "EMBEDDED"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
end_user_email
string<email>
required
​
end_user_organization_name
string
required
Minimum length: 1
​
end_user_origin_id
string | null
Minimum length: 1
​
remote_environment
string | null
​
integration_category
enum<string>
default:HRIS
Available options:
HRIS,
ATS,
ASSESSMENT
​
integration_tool
enum<string> | null
Available options:
personio,
workday,
workdaycustomreport,
workdaycustomreportsftp,
successfactors,
smartrecruiters,
factorial,
oraclerecruiting,
lever,
icims,
cornerstonetalentlink,
recruitee,
recruiterflow,
greenhouse,
greenhousejobboard,
teamtailor,
teamtailorjobboards,
ashby,
talentsoft,
talentsoftcustomer,
concludis,
talention,
piloga,
onlyfy,
ukgpro,
ukgready,
adpworkforcenow,
taleo,
rexx,
afas,
bamboohr,
bullhorn,
bullhornlogin,
workable,
payfitcustomer,
payfitpartner,
payfit,
jobvite,
employmenthero,
fountain,
fourth,
kenjo,
heavenhr,
hibob,
softgarden,
cezannehr,
entraid,
azuread,
googleworkspace,
nmbrs,
pinpoint,
welcometothejungle,
dvinci,
dvinciadmin,
join,
deel,
remotecom,
iriscascade,
okta,
sagehr,
sagepeople,
humaans,
traffit,
erecruiter,
eurecia,
abacusumantis,
umantis,
jobylon,
oraclehcm,
taleez,
officient,
sesamehr,
charliehr,
hrworks,
abacus,
otys,
zohopeople,
zohorecruit,
gusto,
breathehr,
catalystone,
mirus,
alexishr,
simployer,
eploy,
jobdiva,
peple,
youserve,
careerplug,
perview,
eightfold,
dayforce,
hansalog,
lattice,
trinet,
paylocity,
paycor,
namely,
paycom,
insperity,
paychex,
avature,
apploi,
phenom,
rippling,
sapling,
heyrecruit,
peoplehr,
recruhr,
jazzhr,
lucca,
bite,
zelt,
planday,
boondmanager,
homerun,
haileyhr,
mysolution,
carerix,
hroffice,
talentclue,
inrecruiting,
ubeeo,
oysterhr,
kiwihr,
connexys,
hr4you,
cornerstoneondemand,
zvooverecruit,
square,
perbilityhelix,
comeet,
leapsome,
compleet,
compleetpitcher,
gem,
loket,
workforcecom,
laura,
covetorest,
coveto,
peoplefirst,
sdworx,
crelate,
absenceio,
manatal,
avionte,
a3innuvanomina,
mhmhr,
scim,
softgardenpartner,
datevhr,
datev,
datevlug,
sympa,
breezyhr,
flatchr,
applicantstack,
reachmee,
talentadore,
youforce,
nibelis,
peoplexd,
sandbox,
guidecom,
sftp,
sftpfetch
​
language
enum<string> | null
default:en
Available options:
en,
de,
fr,
it,
es
​
scope_config_id
string | null
​
enable_filtering
boolean
default:false
​
enable_field_mapping
boolean
default:false
​
link_type
enum<string>
default:EMBEDDED
Available options:
EMBEDDED,
MAGIC_LINK

Response

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples: