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)
- IT administrator access to the Lark Developer Console
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 Plugins
3. Locate Xilnex for Lark in the available plugins list and click to open it.
4. Click the Configuration card (under Maintenance).
Step 2: Connect Your Lark App
Keep both the Xilnex Portal and the Lark Developer Console open in separate browser tabs throughout this step. Portal also shows a reference guide in the side panel for you to refer.
2a. Create your app in Lark
In the Lark Developer Console, click Create App → Custom App and give it a name. Add simple descriptions, and choose an icon.
2b. Copy your credentials
In your newly created Lark App, go to Credentials & Basic Info in the left menu. Under Credentials, copy the App ID, then click the eye icon to reveal the App Secret and copy that too. Paste both into the matching fields on the Configuration page in Portal accordingly.
2c. Set permissions
Back in Portal, click Copy Permission Scopes to copy the required scopes to your clipboard.
In the Lark Developer Console left menu, go to Development Configuration → Permissions & Scopes. Click Batch import/export scopes.
Under the Import tab, remove the existing content, and paste the scopes into the JSON box, then click Next, Review New Scopes, and Add.
2d. Confirm your connection
Back in Portal, click Save. A green Active indicator next to "Custom App" confirms the connection.
Your Lark workspace is now connected to your Xilnex account. To update your credentials, click the Edit icon.
If the connection does not show Active, see the Troubleshooting section below.
Optional: Set Up the Webhook Token
Only needed if you plan to use Approval Hub or interactive Lark Message Cards, this lets Lark send approve/reject decisions and other responses back to Xilnex. If you're only using Templates (Lark Bases), you can skip this.
1. On the Configuration page, click the Webhook Token tab.
2. In the Lark Developer Console, go to Events & Callbacks → Encryption Strategy tab. Copy the Verification Token, and paste it into the Webhook Token field in Portal.
3. Click Save in Portal first.
4. Following the guide, copy the request URL provided.
5. In the Lark Developer Console, go to Events & Callbacks → Event Configuration. In Subscription mode, click the pencil icon to add new.
6. Click "Send notifications to developer's server," paste the URL in the provided textfield and save.
7. Check for a verification error in Lark. If Lark shows one, confirm the Webhook Token in Portal is correct and try again. If verification has no issues, a green 'Verified' will be visible.
Save the Webhook Token in Portal before saving the request URL in Lark. Lark verifies the URL by calling Xilnex with that token.
Troubleshooting
Connection does not show Active after saving
- Verify that the App ID and App Secret were copied exactly from the Lark Developer Console — no extra spaces or missing characters.
- Confirm the permission scopes were pasted into Permissions & Scopes → Batch Import in the Lark Developer Console before saving.
- Re-enter both values and click Save again.