Sign in

v3

latestOpenAPI 3.1.02026-07-311255771.3 MB
Kombo Connect

Create connection link

Generate a unique link that allows your user to enter the embedded Kombo Connect flow.

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": "test@example.com",
  "end_user_organization_name": "Test Inc.",
  "integration_category": "HRIS",
  "integration_tool": "personio",
  "end_user_origin_id": "123",
  "language": "en",
  "link_type": "EMBEDDED"
}
post/connect/create-link

Request body

end_user_emailstring email required

The email of the user this link is meant for.

end_user_organization_namestring required

The name of the user's organization.

end_user_origin_idstring nullable

The id the user/organization has in your own database.

remote_environmentstring nullable

If the tool you want to connect offers different environments, you can specify which one you want to connect to here. If you don't specify this, we'll assume you want to use the production environment. Note that this can only be used if you've also specified a tool through integration_tool.

integration_category'HRIS' | 'ATS' | 'ASSESSMENT' | 'LMS'

Category of the integration you want your customer to create.

integration_tool'workday' | 'successfactors' | 'smartrecruiters' | 'factorial' | 'oraclerecruiting' | 'lever' | 'icims' | 'cornerstonetalentlink' | 'recruitee' | 'recruiterflow' | 'greenhouse' | 'greenhousev3' | 'greenhousejobboard' | 'teamtailor' | 'teamtailorjobboards' | 'ashby' | 'talentsoft' | 'talentsoftcustomer' | 'concludis' | 'perbilityhelix' | 'talention' | 'piloga' | 'onlyfy' | 'personio' | 'ukgpro' | 'ukgready' | 'adpworkforcenow' | 'taleo' | 'rexx' | 'afas' | 'bamboohr' | 'bullhorn4salesforce' | 'bullhorn' | 'bullhornlogin' | 'workable' | 'jobvite' | 'fountain' | 'softgarden' | 'softgardenpartner' | 'pinpoint' | 'welcometothejungle' | 'dvinci' | 'dvinciadmin' | 'join' | 'sagehr' | 'traffit' | 'erecruiter' | 'abacusumantis' | 'umantis' | 'jobylon' | 'taleez' | 'hrworks' | 'otys' | 'zohorecruit' | 'ceipal' | 'eploy' | 'jobdiva' | 'careerplug' | 'perview' | 'eightfold' | 'paylocity' | 'paycor' | 'avature' | 'apploi' | 'phenom' | 'paradox' | 'heyrecruit' | 'recruhr' | 'recruitcrm' | 'jazzhr' | 'bite' | 'brassring' | 'homerun' | 'mysolution' | 'carerix' | 'carerixgraphql' | 'hroffice' | 'talentclue' | 'inrecruiting' | 'jobadder' | 'ubeeo' | 'connexys' | 'hr4you' | 'cornerstoneondemand' | 'zvooverecruit' | 'odoo' | 'comeet' | 'compleetpitcher' | 'compleetpersy' | 'compleet' | 'gem' | 'laura' | 'covetorest' | 'coveto' | 'mercury' | 'crelate' | 'manatal' | 'avionte' | 'mhmhr' | 'asymbl' | 'breezyhr' | 'flatchr' | 'dayforce' | 'digitalrecruiters' | 'applicantstack' | 'reachmee' | 'talentadore' | 'sandbox' | 'guidecom' | 'spott' | 'logicmelon' | 'loxo' | 'kula' | 'trackerrms' | 'databites' | 'pageup' | 'workdaycustomreport' | 'workdaycustomreportsftp' | 'ukgprowfm' | 'adpdecidium' | 'payfitcustomer' | 'payfitpartner' | 'payfit' | 'employmenthero' | 'fourth' | 'kenjo' | 'heavenhr' | 'hibob' | 'cezannehr' | 'entraid' | 'azuread' | 'googleworkspace' | 'nmbrs' | 'deel' | 'remotecom' | 'iriscascade' | 'okta' | 'sagepeople' | 'humaans' | 'eurecia' | 'oraclehcm' | 'officient' | 'sesamehr' | 'charliehr' | 'abacus' | 'zohopeople' | 'gusto' | 'breathehr' | 'catalystone' | 'mirus' | 'alexishr' | 'simployer' | 'peple' | 'youserve' | 'hansalog' | 'lattice' | 'latticetalent' | 'hoorayhr' | 'trinet' | 'trinetpeo' | 'namely' | 'paycom' | 'insperity' | 'paychex' | 'rippling' | 'sapling' | 'peoplehr' | 'lucca' | 'zelt' | 'planday' | 'boondmanager' | 'haileyhr' | 'silae' | 'oysterhr' | 'kiwihr' | 'square' | 'leapsome' | 'loket' | 'workforcecom' | 'peoplefirst' | 'sdworx' | 'itrent' | 'absenceio' | 'a3innuvanomina' | 'scim' | 'datevlauds' | 'datevhr' | 'datev' | 'datevlug' | 'sympa' | 'youforce' | 'nibelis' | 'peoplexd' | 'sftp' | 'sftpfetch' | '360learning' | 'talentlms' | 'docebo' | 'coursera' | 'udemy' | 'linkedinlearning' | 'moodle' nullable

Pre-define a tool this integration link can be used for.

language'en' | 'de' | 'fr' | 'it' | 'es' nullable

Language of the connection flow UI.

scope_config_idstring nullable

Specify a scope config that should be used for this integration. This is an advanced feature, only use it if you know what you're doing!

enable_filteringboolean

Enable the filtering feature for the integration. HRIS only.

enable_field_mappingboolean

Enable the field mapping feature for this integration.

link_type'EMBEDDED' | 'MAGIC_LINK'

The type of link you want to create. EMBEDDED is for the embedded flow using the Kombo Connect SDK (these links are valid for 1 hour) and MAGIC_LINK is for magic links which you send out manually to customers (there are valid for 1 year).

This defaults to EMBEDDED, which is our recommended method of implementing the connection flow for a seamless user experience.

Response

POST /connect/create-link Positive response

status'success' required

Example response

{
  "data": {
    "link": "https://connect.kombo.dev/v1?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.SWYgeW91IGFyZSByZWFkaW5nIHRoaXMsIHdlIHdvdWxkIGxpa2UgdG8gbGV0IHlvdSBrbm93IHRoYXQgd2UgYXJlIGhpcmluZyBwZW9wbGUgbGlrZSB5b3UgOikuIFJlYWNoIG91dCB0byBhbGV4QGtvbWJvLmRldiB0byBnZXQgaW4gY29udGFjdCBhbmQgdGVsbCBoaW0geW91IGNvbWUgZnJvbSB0aGUgSldUIDsp._hhX5YTtHfLn9ZC806dZceRn2whzxHyrhft1ONzNgOE"
  }
}