Connector Configuration
Search AI interacts with Zeplin via APIs. You can authenticate using either of the following methods:- Personal Access Token — generate a token directly in your Zeplin profile
- OAuth 2.0 — create an OAuth app in Zeplin and use the app credentials
Prerequisites
Generate a Personal Access Token
- Go to your Profile page in Zeplin.
- Navigate to the Developer page.
- Under Personal access tokens, select Create new token.
- Enter a name for the token.
- Select Enable admin access.
- Select CREATE. The access token is generated.
- Copy the token — it will not be visible after you leave the page.
Create an OAuth App in Zeplin
- Go to your Profile page in Zeplin.
- Navigate to the Developer page.
- Under Owned Zeplin apps, select Create new app.
- Provide the following details:
- Name — unique, identifiable name for the app
- Summary — brief description of the app’s purpose
- Website — your website URL
- Redirect URIs — use one of the following based on your region or deployment:
- JP Region:
https://jp-bots-idp.kore.ai/workflows/callback - DE Region:
https://de-bots-idp.kore.ai/workflows/callback - Production:
https://idp.kore.com/workflows/callback
- JP Region:
- Select CREATE. A client ID and client secret are generated. Use these when configuring the connector in Search AI.
Configure the Zeplin Connector in Search AI
On the Authorization tab of the connector, provide the following details.
When using API Key authentication:
When using OAuth 2.0 authentication:
Click Connect to initiate authentication.
Content Ingestion
After connecting the Zeplin account, go to the Configuration tab and select Sync Now to start ingestion. Use the Scheduler to set up a one-time or recurring sync. Each screen is ingested as a separate document in Search AI with the following structure:RACL Support
In Zeplin, access to screens is controlled at the project level. Anyone with access to a project automatically has access to all screens within that project. When content is ingested into Search AI, the project ID is stored in thesys_racl field of the ingested chunks. These project IDs act as permission entities that control access.
Search AI supports automatic resolution of permission entities for Zeplin screens. It automatically identifies users with access to each project and associates them with the corresponding project ID permission entity — no manual API mapping is required.