How to Install and Set Up Xilnex for Lark (Custom App)

How to Install and Set Up Xilnex for Lark (Custom App)

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


Info
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.

Alert
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.



Alert
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.
    • Related Articles

    • Introducing Xilnex for Lark

      Product Introduction Xilnex for Lark connects your Xilnex ClassicPOS system to Lark Suite. If your team is used to exporting reports, copying numbers into spreadsheets, or chasing approvals over chat, this replaces that manual work: your sales, ...
    • Managing Lark User Email Mapping in Xilnex for Lark

      Overview The Users card matches each Xilnex user to their Lark account by email. This is what lets features like Permission Approvals and Document Approvals deliver Lark cards to the right person. This article covers how to review the mapping and fix ...
    • Disconnecting or Reconnecting Xilnex for Lark

      This article covers how to disable a template, fully disconnect the integration from Lark, and reconnect it again. Disable a Template Turning a base off only stops that one base, everything else keeps syncing, and none of your existing data in Lark ...
    • Creating a Base in Xilnex for Lark

      Overview This article walks you through creating a base for a template, giving end users access to it in Lark, and verifying data is syncing correctly. Xilnex for Lark must already be connected before you start. If the Templates card isn't accessible ...
    • Xilnex-AutoCount - Portal Configurations

      All integration rules and configurations are managed through the Xilnex Web Portal. This guide walks you through accessing the portal and introduces the three core configuration areas. Accessing the Xilnex Web Portal: Open your web browser and ...
    • Recent Articles

    • Managing Lark User Email Mapping in Xilnex for Lark

      Overview The Users card matches each Xilnex user to their Lark account by email. This is what lets features like Permission Approvals and Document Approvals deliver Lark cards to the right person. This article covers how to review the mapping and fix ...
    • E-Wallet and Credit Card Payment - Recheck Status & Force Complete

      This guide walks you through what to do when a payment goes through on the terminal or e-wallet, but Classic POS fails to commit sales. When Does This Happen? During payment, Classic POS will show a "Connecting to Ewallet party..." or processing ...
    • E-Journal for BIR Compliance (Philippines)

      Overview The E-Journal feature generates a .txt file that complies with BIR (Bureau of Internal Revenue) requirements in the Philippines. This feature is available only for the Philippines COM. Users from other countries' COMs will not be able to ...
    • Disconnecting or Reconnecting Xilnex for Lark

      This article covers how to disable a template, fully disconnect the integration from Lark, and reconnect it again. Disable a Template Turning a base off only stops that one base, everything else keeps syncing, and none of your existing data in Lark ...
    • Creating a Base in Xilnex for Lark

      Overview This article walks you through creating a base for a template, giving end users access to it in Lark, and verifying data is syncing correctly. Xilnex for Lark must already be connected before you start. If the Templates card isn't accessible ...
    • Popular Articles

    • Basic - How to create a voucher-coupon

      Voucher and coupon definition Voucher can be generated in bulk and can be used once Coupon can only be created one at a time (reusable code) and can be use multiple times Pre-voucher / coupon setup There are 2 things need to be prepared before we can ...
    • Understanding DuitNow QR Payment in ClassicPOS

      Introduction This document introduces the DuitNow QR payment feature available in the Xilnex Retail POS, enabling merchants to accept payments conveniently through Malaysia's national QR payment standard. The integration of DuitNowQR simplifies the ...
    • Intermediate - How to Configure and Use Approval Settings in Purchase Orders (PO)

      1.0 What is approval setting In general, "approval setting" refers to the configuration or process by which a request, action, or change must be reviewed and approved before it proceeds. The term is often used in business, software applications, and ...
    • Buy 2 for Special Price Promotion

      Use Case: Stock clearance, seasonal offers, or spotlight products. From the sample screenshot above, this promotion requires 2 items to trigger. If only 1 Milk Tea is added to the sales list, no discount will apply since the condition of 2 items is ...
    • Creating Delivery Type for Sales in Classic POS

      How to Create Delivery Type 1. Access to the [System Configuration] 2. Select the [Sales] section 3. In the [All Outlets] tab, look for the 'Delivery Type' 4. Click on the [Configure] In the Delivery Type Setup form: 1. Enter the Delivery Type. 2. ...