KOkombo
General

Create Setup Flow link

Changed on

Create a link that lets your customer run the Setup Flow for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to showKomboConnect from the Kombo Connect SDK, the same way you do with a connection link.

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.

post/integrations/{integration_id}/setup-link

Request

Path parameters

integration_idstring required

POST /integrations/:integration_id/setup-link Parameter

Request body

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

Language of the setup flow UI.

link_type'EMBEDDED' | 'MAGIC_LINK' 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).

Response

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

status'success' required

Changes