KuikAgents Integration allows you to embed live dashboards from the KuikAgents app into your Kuika app in a tenant-specific and authenticated manner. This integration is not a one-way embedding, but a two-way live synchronization. Changes made on the KuikAgents side (e.g., adding a new dashboard) are automatically reflected in the AgentDashboard element in Kuika. Corresponding actions performed on the Kuika side also become visible on the KuikAgents side.
You can configure these settings in the Kuika Config Manager module, under the Web tab of the configuration. In this guide, you’ll first learn how to retrieve the necessary keys from the KuikAgents app, and then follow step-by-step instructions on how to configure the integration in Kuika.
How to Set Up KuikAgents Integration?
1. Retrieve the Keys from the KuikAgents App
Before configuring the settings on the Kuika side, you must retrieve the Access Secret and Identity Secret values from the KuikAgents app.
In the Listened Channels section, click the Configure option for the website widget.
In the Display on Website window that opens:
Enter the domain address of the Kuika app where you’ll display the dashboard in the Allowed origins field (e.g., https://uygulamaniz.com).
Check the Recognize the logged-in user option. This option ensures that a user logged into your Kuika app sees the dashboard with their own data and permissions. If left unchecked, visitors will view the dashboard anonymously.
Click the Publish button.
Click the Refresh Token button. This action generates an Identity Secret (kS_...). Save this value immediately using the Copy button.
In the script box below, click the Copy Snippet button to copy the embed script containing the Access Secret (kE_...).
Identity Secret (kS_...) is displayed only once. Be sure to save it before closing the window. If you lose it, you’ll need to generate a new secret using Refresh Token, and the previous secret will become invalid.
The Refresh Token process may break the integration of any live tenant using this token. Perform the renewal only on test tenants that are not used in production. Before renewing a tenant used in production, confirm with the relevant team.
2. Open or Create the Configuration
Log in to the Kuika platform.
From the Apps screen, open the project you will be working on.
Click the Config Manager module in the top menu.
To create a new configuration, click the Create a blank configuration card, give the configuration a name, and complete the creation process. If you want to use an existing configuration, click its name in the list.
3. Go to the KuikAgents Integration Settings
From the tabs at the top of the configuration screen, select the Web tab.
In the PLATFORM section on the right, make sure the Support Web UI toggle is enabled.
Under the Web App heading in the left menu, select the KuikAgents Integration setting. You can also use the search field in the top-left corner to find the setting.
4. Add an Integration Configuration
Click the ADD NEW link below the Configuration field.
In the KUIKAGENTS INTEGRATION window that opens, fill in the following fields:
Name (required): The name of the configuration.
KuikAgents URL (required): The deployment origin address that serves the Dashboard and chat bundles, as well as the API. The field defaults to https://agents.kuika.com. KuikAgents is typically deployed on-premises to prevent customer data from leaving the organization. In this case, enter your project-specific KuikAgents address in this field (e.g., https://twin.sirketiniz.com).
Access Secret (Embed Token) (required): The token value (kE_...) from the script you obtained by clicking Copy Snippet in Step 1.
Identity Secret (per-user) (required): The Identity Secret (kS_...) displayed after clicking Refresh Token in Step 1. This key maps users viewing the dashboard to actual KuikAgents users and is stored only on the server side.
Show chat on all screens: When enabled, the agent chat button appears in the lower-right corner of all screens except authentication (auth) screens. When disabled, you must add the Agent Chat element to a specific screen to display the chat there.
Click the CREATE button.
Select the configuration you created from the Configuration dropdown menu.
5. Save the Settings
Make sure to fill out all required (*) fields completely and accurately.
Click the UPDATE button in the top-right corner to save your changes.
Two-Way Synchronization
Once the configuration is complete, when you add the AgentDashboard element to a page in the UI Design screen, the dashboard content defined for that tenant in KuikAgents will automatically be displayed. Synchronization is two-way:
If you add a new dashboard in the KuikAgents app, this change will automatically appear when you preview the screen containing the AgentDashboard element in Kuika.
Any related changes made on the Kuika side will also be reflected on the KuikAgents side in the same way.
If a dashboard has not yet been designed for the relevant agent on the KuikAgents side, the element will appear empty. The content will be displayed once the design is completed on the KuikAgents side.
This eliminates the need for additional synchronization or manual data transfer between the two platforms.
Important Tips
Access Secret and Identity Secret are sensitive information. Do not share these values via email, chat, or code repositories.
The domain you enter in the Allowed Origins field must match exactly the address where your application is hosted. If your test and production environments use different domains, add both.
You can create separate configurations for test and production environments and select the one you need from the Configuration menu.
Once you’ve completed these steps, KuikAgents dashboards will be displayed in your Kuika application in a user-specific and real-time manner.
