Skip to main content
POST
/
integrations
/
{integration_id}
/
setup-link
Python
from kombo import Kombo


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

    res = k_client.general.create_setup_link(integration_id="personio:93fCvorjZ2jas7ZekX1V1n5d", link_type="EMBEDDED", language="en")

    # Handle response
    print(res)
{
  "status": "<string>",
  "data": {
    "link": "<string>"
  }
}
The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a PLATFORM.INPUT_INVALID error. Steps can be enabled from the Integration Settings tab in the dashboard or via the Create Connection Link endpoint.

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Path Parameters

​
integration_id
string
required

POST /integrations/:integration_id/setup-link Parameter

Body

application/json

POST /integrations/:integration_id/setup-link Request body

​
link_type
enum<string>
required

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 (these are valid for 1 year).

Available options:
EMBEDDED,
MAGIC_LINK
​
language
enum<string> | null
default:en

Language of the setup flow UI.

Available options:
en,
de,
fr,
it,
es

Response

POST /integrations/:integration_id/setup-link Positive response

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