v3

latestOpenAPI 3.1.02026-07-311255771.3 MB
Unified HRIS API

Create provisioning setup link (deprecated)

Create a new link that can be passed to the Kombo Connect SDK to open the provisioning setup UI.

<Warning> **This endpoint is deprecated!**

Please use the Create Setup Flow link endpoint instead. It supports the full Setup Flow (including filtering, field mapping, and any other enabled steps) and works for any integration category, not just HRIS. </Warning>

post/hris/provisioning-groups/{group_id}/setup-links

Path parameters

group_idstring required

ID of the provisioning group (currently only default is allowed).

ID of the provisioning group (currently only default is allowed).

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

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

Language of the UI. Please note that the provisioning setup UI is not translated yet but we're working on it and setting this already will make sure the translations appear once released.

Response

POST /hris/provisioning-groups/:group_id/setup-links Positive response

status'success' required

Example response

{
  "data": {
    "url": "https://connect.kombo.dev/v1/setup?token=GinuMJCpUQ9xdpLmD2ocw8qdiK3qiPCizDCv754EXri2vAX4",
    "expires_at": "2023-10-11T12:00:00.000Z"
  }
}