{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PostConnectCreateLinkRequestBody",
"title": "PostConnectCreateLinkRequestBody",
"type": "object",
"properties": {
"end_user_email": {
"type": "string",
"description": "The email of the user this link is meant for.",
"format": "email"
},
"end_user_organization_name": {
"type": "string",
"minLength": 1,
"description": "The name of the user's organization."
},
"end_user_origin_id": {
"type": [
"string",
"null"
],
"minLength": 1,
"description": "The id the user/organization has in your own database."
},
"remote_environment": {
"type": [
"string",
"null"
],
"description": "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": {
"type": "string",
"enum": [
"HRIS",
"ATS",
"ASSESSMENT",
"LMS"
],
"default": "HRIS",
"description": "Category of the integration you want your customer to create."
},
"integration_tool": {
"type": [
"string",
"null"
],
"enum": [
"workday",
"successfactors",
"smartrecruiters",
"factorial",
"oraclerecruiting",
"lever",
"icims",
"cornerstonetalentlink",
"recruitee",
"recruiterflow",
"greenhouse",
"greenhousejobboard",
"teamtailor",
"teamtailorjobboards",
"ashby",
"talentsoft",
"talentsoftcustomer",
"concludis",
"talention",
"piloga",
"onlyfy",
"personio",
"ukgpro",
"ukgready",
"adpworkforcenow",
"taleo",
"rexx",
"afas",
"bamboohr",
"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",
"hroffice",
"talentclue",
"inrecruiting",
"ubeeo",
"connexys",
"hr4you",
"cornerstoneondemand",
"zvooverecruit",
"odoo",
"comeet",
"compleet",
"compleetpitcher",
"gem",
"laura",
"covetorest",
"coveto",
"mercury",
"crelate",
"manatal",
"avionte",
"mhmhr",
"asymbl",
"breezyhr",
"flatchr",
"dayforce",
"digitalrecruiters",
"applicantstack",
"reachmee",
"talentadore",
"sandbox",
"guidecom",
"spott",
"loxo",
"kula",
"workdaycustomreport",
"workdaycustomreportsftp",
"ukgprowfm",
"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",
"perbilityhelix",
"leapsome",
"loket",
"workforcecom",
"peoplefirst",
"sdworx",
"itrent",
"absenceio",
"a3innuvanomina",
"scim",
"datevlauds",
"datevhr",
"datev",
"datevlug",
"sympa",
"youforce",
"nibelis",
"peoplexd",
"sftp",
"sftpfetch",
"360learning",
"talentlms",
"udemy",
"linkedinlearning",
"moodle"
],
"description": "Pre-define a tool this integration link can be used for."
},
"language": {
"type": [
"string",
"null"
],
"enum": [
"en",
"de",
"fr",
"it",
"es"
],
"default": "en",
"description": "Language of the connection flow UI."
},
"scope_config_id": {
"type": [
"string",
"null"
],
"description": "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_filtering": {
"type": "boolean",
"default": false,
"description": "Enable the [filtering feature](https://docs.kombo.dev/other/filtering) for the integration. HRIS only."
},
"enable_field_mapping": {
"type": "boolean",
"default": false,
"description": "Enable the [field mapping feature](https://docs.kombo.dev/hris/features/setup-flow/introduction#field-mapping) for this integration."
},
"link_type": {
"type": "string",
"enum": [
"EMBEDDED",
"MAGIC_LINK"
],
"default": "EMBEDDED",
"description": "The type of link you want to create. `EMBEDDED` is for the [embedded flow](../guides/connect/embedded-flow) using the Kombo Connect SDK (these links are valid for 1 hour) and `MAGIC_LINK` is for [magic links](../guides/connect/magic-links) which you send out manually to customers (there are valid for 1 year).\n\nThis defaults to `EMBEDDED`, which is our recommended method of implementing the connection flow for a seamless user experience."
}
},
"required": [
"end_user_email",
"end_user_organization_name"
]
}