> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Setup Flow

> Let your customers configure their integration end-to-end.

<img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/setupflow-header.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=ba4d391cf28a46f29c264986c0ba9b9d" alt="Setup Flow" width="3032" height="1756" data-path="images/setupflow-header.png" />

The [Connection Flow](/kombo-connect) lets your customers authenticate and
validate their credentials. The Setup Flow covers everything that comes after:
any additional configuration the integration needs before it can sync the right
data. It is presented to your customers as a self-serve UI inside the Kombo
Connect SDK, so they can complete it without you building anything yourself.

## What appears in the Setup Flow

Each integration decides which steps it actually needs. The most common ones
are:

* **[Field mapping](../custom-fields#self-serve-custom-field-configuration)**,
  where customers connect your custom fields to fields in their tool. Available
  for any category as long as you've defined custom fields.
* **[Employee filtering](/hris/features/filtering/introduction)**, where HRIS
  customers choose which employees Kombo should sync.
* **Tool-specific steps**, surfaced automatically by some connectors (for
  example Greenhouse, Teamtailor, or SCIM) to handle one-time configuration that
  the tool itself requires, like activating webhooks or providing additional
  credentials.

Steps only show up when they are relevant. If a customer connects a tool that
does not support filtering, the filtering step is hidden even when the feature
is enabled on the integration.

## Enabling Setup Flow steps

Field mapping and employee filtering are opt-in per integration. Tool-specific
steps require no configuration on your side, they appear automatically when
needed.

### When creating a new integration

In the Dashboard, open the [Integrations
page](https://app.kombo.dev/integrations) and toggle the steps you want at the
bottom of the create-link form.

<img
  src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/setup-flow-integration-creation-form.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=ec56dd464ad62c2a917d9038404311c2"
  alt="Integration Creation Form Setup Flow
Toggles"
  width="810"
  height="514"
  data-path="images/setup-flow-integration-creation-form.png"
/>

You can do the same via the API by setting `enable_field_mapping` and/or
`enable_filtering` (HRIS only) to `true` on the [Create Connection Link
endpoint](../../v1/post-connect-create-link).

### For an existing integration

Open the integration in the Dashboard and use the toggles in the **Integration
Settings** tab.

<img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/setupflow-integration-settings.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=cd1e8d76b22b4f84e8e9890f445f09ad" alt="Integration Settings Setup Flow Toggles" width="1740" height="1072" data-path="images/setupflow-integration-settings.png" />

## Showing the Setup Flow to your customers

Setup Flow steps run automatically as part of the [Connection
Flow](/kombo-connect) the first time a customer connects a tool, so the
embedded flow you already have in place will pick them up without any changes.

To send customers back into the Setup Flow later, for example to update field
mappings or change which employees are synced, create a setup link with the
[Create Setup Flow link
endpoint](../../v1/post-integrations-integration-id-setup-link) and pass it to
`showKomboConnect` from the [Kombo Connect
SDK](../../guides/connect/embedded-flow#opening-the-flow), the same way you do
with a connection link.

You can also generate a setup link from the Integration Details page in the
Dashboard if you'd rather not wire up the API yourself.
