> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/zapier-integration-setup.md).

# Zapier Integration Setup

### Getting Started

Use this guide to connect Zapier to your BalkanID tenant. You will need a SCIM API token from Zapier and access to the Integrations section in BalkanID.

{% hint style="info" %}
Zapier's SCIM API is available only on Zapier **Enterprise** accounts with Workspaces. If your Zapier account is on another plan, contact your Zapier account manager before configuring this integration.
{% endhint %}

#### Requirements:

Before you begin, collect the following value from Zapier:

* **Zapier SCIM API Token**

### Configure Zapier within your BalkanID tenant

1. To find the Zapier SCIM API Token, sign in to Zapier as an Admin, Super admin or Owner.
2. Navigate to **Settings** > **User provisioning** and turn on user provisioning. Zapier generates a SCIM bearer token and displays it alongside the SCIM base URL.
3. Copy the token. Regenerating it in Zapier invalidates the previous value, so store it before leaving the page.
4. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2F8Cxc8ghY6AWOjpVHTYbw%2Fzapier-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Integrations</p></figcaption></figure></div>

5. Search for **Zapier**, select it, then click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2F4YPIZT21vUMWJp5hqjTT%2Fzapier-connect-application.png?alt=media" alt="The Connect a new application step with Zapier searched for and selected"><figcaption><p>Connect a new application</p></figcaption></figure></div>

6. Under **Select Extraction Type**, keep **Direct Configuration** selected and paste your token into **Zapier SCIM API Token**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2F393ikyAWHkFKfUJTZDJ8%2Fzapier-direct-configuration.png?alt=media" alt="The Direct Configuration extraction type with the Zapier SCIM API Token field"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

7. Click Next to move onto Optional Configuration.
8. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step of the integration wizard"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

9. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

{% hint style="info" %}
Zapier's SCIM API reports accounts and the teams they belong to. It does not expose Zapier account roles or workspace roles, so roles are not extracted. Zapier also hides deactivated accounts from the SCIM API, so an extract reflects active accounts only.
{% endhint %}

### Integration Scopes

| Read Only Scopes                                                                                                                                                                    | Lifecycle Management Scopes |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| **SCIM user provisioning (Read)** — reads Zapier accounts, teams and team membership through Zapier's SCIM API. Generating the token requires the Admin, Super admin or Owner role. | N/A                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/zapier-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
