> ## 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

Before you can get started with development, there’s a bit of setup to do. Please follow the steps below carefully so that you won’t have any issues down the line.

## Log into the dashboard

Login to the Kombo dashboard. You should have received an invite via email but if you didn’t, reach out to your team members or to Kombo directly via Slack/Teams

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/dashboard-home.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=40504f91f9c17d026b34b70317dc3323" alt="Kombo Dashboard" width="2940" height="1664" data-path="images/hris-implementation-guide/dashboard-home.png" />

## Scope configuration

<Note>
  The scope config allows you to set which models and properties will be included when reading data from Kombo. Additionally, when your customers create an integration, they will only be prompted to grant permission to read the properties included in your scope config.

  To understand more about this feature and how to use it to evoke a great first impression with customers, [read more here](/hris/features/scopes)
</Note>

Go to the [scopes overview](https://app.kombo.dev/scope-config) and click on “**New config**” or “**Edit**” an existing one.

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/edit-or-create-scope-config.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=bcdba706bfb6035ec8c43987f36642d6" alt="1376" width="2940" height="1596" data-path="images/hris-implementation-guide/edit-or-create-scope-config.png" />

Select the data models that you need and click on “**Save changes**”.

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/editing-scope-config.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=76046b7f860b999314665a40c6230611" alt="Editing scope config" width="2940" height="1596" data-path="images/hris-implementation-guide/editing-scope-config.png" />

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/saving-scope-config.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=0e4d94832cf2e8ed3953fd9658d906c8" alt="Saving scope config" width="2940" height="1596" data-path="images/hris-implementation-guide/saving-scope-config.png" />

## Integration configuration

Go to the [tools overview](https://app.kombo.dev/tools) and select/deselect all tools that you want to offer. You can change this at any time.

You can also select if you want to enable newly released tools; on average Kombo adds one tool per week.

<img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-integration-conf.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=f16460815beaa8bba56d3f6384bdcefd" alt="Integration configuration" width="1471" height="834" data-path="images/ta-integration-conf.png" />

## Set up a linked account for development

To call the API you always need to have a linked HRIS account to pull and push data from. You can either use our built-in mock integration to get started quickly (recommended), or [get yourself a sandbox via a free trial](/hris/getting-started/sandbox-integrations).

To use our built-in sandbox, go to the [integrations tab](https://app.kombo.dev/integrations) and click on “**New integration**”, selecting **Kombo Sandbox** as your tool.

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/create-integration.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=d531912b504fdc0a9170b7a80b0095fd" alt="Create integration" width="2940" height="1596" data-path="images/hris-implementation-guide/create-integration.png" />

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/create-kombo-sandbox.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=c92f6dd5f2f79bf87d3b24e50e076180" alt="Select kombo sandbox" width="2940" height="1664" data-path="images/hris-implementation-guide/create-kombo-sandbox.png" />

What you see now is the so-called connection flow. Customers will see the UI when connecting their HRIS to your product via Kombo. You can preview the various connection flows of the different tools on the [tools page](/hris/guides/implementing-new-tools#resources).

Click “**Continue**” and “**Set up integration**”.

<div style={{ display: 'flex', justifyContent: 'space-between', gap: '1rem' }}>
  <img src="https://mintcdn.com/kombo/Rjeo5fuDzUBK3i-0/images/ta-setup-sandbox-1.png?fit=max&auto=format&n=Rjeo5fuDzUBK3i-0&q=85&s=8a948bdf66c792450f63bf6b952d2994" alt="First Image Description" width="694" height="1226" data-path="images/ta-setup-sandbox-1.png" />

  <img src="https://mintcdn.com/kombo/Rjeo5fuDzUBK3i-0/images/ta-setup-sandbox-2.png?fit=max&auto=format&n=Rjeo5fuDzUBK3i-0&q=85&s=7e0d400325786f9e5440df6da1793c67" alt="Second Image Description" width="718" height="1246" data-path="images/ta-setup-sandbox-2.png" />

  <img src="https://mintcdn.com/kombo/Rjeo5fuDzUBK3i-0/images/ta-setup-sandbox-3.png?fit=max&auto=format&n=Rjeo5fuDzUBK3i-0&q=85&s=c342211a0aa533156b9cabdbdf358adb" alt="Third Image Description" width="730" height="1256" data-path="images/ta-setup-sandbox-3.png" />
</div>

**Click** on the tile that just appeared to get to the details page of the integration.

<img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-integration-details.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=dc69e114f21f702856d33541988c8514" alt="Integration details" width="1610" height="544" data-path="images/ta-integration-details.png" />

On this page, you can find all info related to the integration. For now, you will only need the integration ID.

<img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-integration-details-1.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=255c52cce84641170c7f16921bd67a71" alt="Integration details 1.png" width="500" data-path="images/ta-integration-details-1.png" />

## Set up webhooks

Webhooks are a fundamental part of your Kombo implementation. There are multiple different webhook types for different purposes (you can find all of them here) but setting them up always works the same:

Go to the [webhooks tab](https://app.kombo.dev/configuration/webhooks)

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/go-to-webhook.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=c80cb88ace2bf90f48b5d4d7bd9b0cc5" alt="Webhook tab" width="2936" height="1596" data-path="images/hris-implementation-guide/go-to-webhook.png" />

Create a webhook, give it a descriptive label, enter the URL, and select the desired type.

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/create-webhook.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=b279764d54be10d190574653db7f1c6b" alt="Create webhook" width="2940" height="1594" data-path="images/hris-implementation-guide/create-webhook.png" />

Send a test webhook by clicking the test button

<img src="https://mintcdn.com/kombo/gOJSp7BFh1-OoJE6/images/hris-implementation-guide/test-webhook.png?fit=max&auto=format&n=gOJSp7BFh1-OoJE6&q=85&s=f6d2b61bbff12b81480f8be0bdf0bf00" alt="Test webhook" width="2940" height="1595" data-path="images/hris-implementation-guide/test-webhook.png" />

<Info>
  Later on in this guide, we will talk more about the most important types of
  webhooks, but you can find an all-encompassing overview on our [webhooks
  page](/hris/guides/webhooks)
</Info>

## Create Kombo API key

Go to the [Secrets tab](https://app.kombo.dev/secrets) and click on “**New API key**”.

<img src="https://mintcdn.com/kombo/Rjeo5fuDzUBK3i-0/images/ta-secrets-tab.png?fit=max&auto=format&n=Rjeo5fuDzUBK3i-0&q=85&s=4a0154f6b12cd5223c4cfafab57839bc" alt="Secrets tab" width="2938" height="1136" data-path="images/ta-secrets-tab.png" />

Name the API key and click “**Create API key**”.

<img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-create-key.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=c57c508e236ea4d9764bc2fdae79bc38" alt="Create API key.png" width="400" data-path="images/ta-create-key.png" />

Copy the token and store it somewhere safe.

<img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-copy-key.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=4c5f8e2300a88c497dadf43d36023fca" alt="Create API key.png" width="450" data-path="images/ta-copy-key.png" />

## Test your setup

🎉 You made it through the setup and have everything in place to get started developing 🎉

To verify you set up the sandbox integration and API key correctly, try the following HTTP request to the [“get integration details”-endpoint](/hris/v1/get-integrations-integration-id)

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/integrations/{integration_id} \
  --header 'Authorization: <api_key>'
```

You can also use any other endpoint like [“get employees”](/hris/v1/get-employees) or [“get legal entities”](/hris/v1/get-legal-entities). The Sandbox integration will return you some sample data for it.

<Tip>
  **Tip:** You can use our [official server-side SDKs](/libraries-and-sdks) to
  interact with the Kombo API in an ergonomic and type-safe manner. Check if
  your tech stack is already supported!
</Tip>

## Optional: set up Postman collection

To make development easier, we recommend setting up a Postman collection. It takes only one minute and can be done like this:

* **Copy** the link of our OpenAPI schema:

  ```bash theme={null}
  https://api.kombo.dev/openapi.json
  ```

* Open Postman, and click **Import**
  <img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-postman-import.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=b24e1846db950a04d35677857f2d22c2" alt="1376" width="944" height="284" data-path="images/ta-postman-import.png" />

* **Paste** the URL and click **Import**

  <img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-postman-url.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=693ba329cec010a679ec17b0f7ad02d2" alt="Postman URL.png" width="450" data-path="images/ta-postman-url.png" />

  <img src="https://mintcdn.com/kombo/DniMaFamDeZQwfSo/images/ta-postman-collection.png?fit=max&auto=format&n=DniMaFamDeZQwfSo&q=85&s=c2d478d992683e7f9a39af15be36d8f4" alt="Postman Collection.png" width="500" data-path="images/ta-postman-collection.png" />
