How to Install and Set Up Xilnex for Lark
Overview
This article walks you through connecting your Lark workspace to your Xilnex account. This is a one-time setup step performed by an IT administrator, using the Configuration card in Xilnex Portal.
Before You Begin
Confirm you have the following:
- Active Xilnex ClassicPOS account and access to Xilnex Portal
- Permission to access the "Plugin: Xilnex for Lark" module in Xilnex Portal
- Active Lark Suite account (free tier is supported)
- Admin access in Lark to install marketplace apps
Step 1: Access Xilnex Portal Plugins
1. Log in to Xilnex Portal with your IT administrator credentials.
2. Click the [...] icon on the top right corner which displays a kebab menu, click on Plugin
3. Locate Xilnex for Lark in the available plugins list and click to open it.
4. Click the Configuration card (under Maintenance).
Step 2: Install Xilnex for Lark in the Lark App Directory
The Configuration page shows that the integration is in 'Not Connected' status, and a short onboarding guide alongside the connection panel. If Xilnex for Lark isn't installed in your Lark workspace yet:
1. Click Redirect to Lark to be redirected to Xilnex for Lark in Lark App Directory.
2. Or manually go to the Lark App Marketplace and search for "Xilnex for Lark." Click Get to install the app.
3. Once the app is successfully installed, you can start to configure users in Lark, however that isn't required to connect. You can skip straight to Step 3 to connect with Xilnex.
Step 3: Authorize the Connection
1. Return back to the Configuration page in Xilnex Portal, click Authorize.
2. This opens Lark's Authorization consent screen. Review and approve the authorization between Lark and Xilnex.
3. Status turns Active. You are now connected.
If you click Authorize before installing the app or your Lark account doesn't have permission, the Lark Authorization page will ask you to install the app first or switch accounts. Once you do, come back to the Configuration page and click Authorize again. It doesn't resume automatically.
Unlinking
If you have authorized the wrong Lark tenant or Xilnex account by mistake, for example if you have multiple Lark accounts and picked the wrong one, use the Unlink button to fix it.
1. On the Configuration page, under the Lark Connections details there is a Manage connection field, followed by the Unlink button.
2. Click on Unlink
3. A confirmation popup explains: 'This clears the connection on the Xilnex side only. The app stays installed and active in Lark, and you can relink anytime by clicking Authorize.'
4. Click Yes, Unlink to proceed.
The page returns to the same Not Connected screen from Step 3, the one you saw before you authorized. Nothing changes on the Lark side. The app is still installed and stays active in Lark. Simply click Authorize and go through the Lark Authorization consent screen again, this time with the correct account.
Unlink is different from disabling the app in Lark. To stop using Xilnex for Lark, see [Disconnecting or Reconnecting Xilnex for Lark].
Good to know
You can only Authorize while Xilnex for Lark is enabled in Lark. If it's been deactivated there, Authorize won't work until you re-enable it first.