Skip to main content

Integrate Lark Approval Workflows

Use this guide to connect the international Lark approval service to NineData.

Before you begin​

  • You have already created or joined an organization, and the organization has subscribed to DevOps Enterprise. Please ensure that your annual or monthly subscription is still active. For more information, please refer to Manage Organizations.
  • Your current account has been switched to the target organization. For more information, please refer to Switching to an Organization.
  • Sign in to Lark Developer as a Lark administrator or application administrator.
  • Sign in to NineData with system administrator permissions.
  • Confirm that the current NineData organization is the authorized organization for this integration.

Notes​

  • Use Lark Developer for the international Lark service. Do not substitute the Feishu China Open Platform.
  • Feishu and Feishu Lark are separate external approval channels in NineData.
  • If automatic approval-definition initialization does not create a usable template, create the Lark approval definition manually and then create the mapping definition in NineData.
  • The approval definition ID must come from the current Lark application.

Step 1: Create and publish a Lark approval application​

  1. Open Lark Developer and sign in.
  2. Create an enterprise self-built application, or open an existing application.
  3. On Credentials and Basic Information, record the App ID and App Secret.
  4. In Permissions, enable at least approval:approval, approval:approval:readonly, approval:definition, and contact:user.id:readonly.
  5. Create and publish a version from Version Management and Release.

Step 2: Bind the Lark approval channel in NineData​

  1. Sign in to the NineData Console.

  2. In the left navigation bar, click Database DevOps > Standards and Processes > Approval Processes > External Process Channels.
  3. Confirm that the panel contains Feishu, Feishu Lark, and IT Service Platform cards.
  4. Click Configure Now on the Feishu Lark card.
  5. Enter the App ID and App Secret, and click OK.
  6. Reopen the application details and record the Callback URL.

Step 3: Configure events and callbacks in Lark​

  1. Open the same application in Lark Developer.
  2. Click Events and Callbacks.
  3. Set the subscription method to Send events to the developer server, enter the callback URL from Step 2, and save.
  4. Add the Approval Instance Status Change event and save the configuration.

Step 4: Prepare an approval definition in Lark​

  1. Open the Lark Approval Admin.
  2. Create a custom approval.
  3. Prefer single-line text, multi-line text, and single-select controls when designing the form so that NineData can map fields reliably.
  4. Publish the approval definition and record its Approval Definition ID.

Step 5: Create an approval mapping definition in NineData​

  1. Return to the External Process Channels panel and open Approval Process Mapping Definitions.
  2. Click Add Approval Process Definition.
  3. Select the Lark application, enter a name, and paste the Approval Definition ID.
  4. After NineData retrieves the approval fields, map the platform fields and option parameters, then save.

Step 6: Bind the mapping to an approval process​

  1. Sign in to the NineData Console.

  2. In the left navigation bar, click Database DevOps > Standards and Processes > Approval Processes.
  3. Select the target process and click Edit.
  4. Enable External Approval Process.
  5. Select the Feishu Lark application and the mapping definition created in Step 5, then save.

Troubleshooting​

Automatic initialization reports that no approval template is available​

Do not select automatic initialization. Finish channel binding, callback configuration, and event configuration first. Then create the approval definition and mapping definition manually.

Fields are not retrieved after entering an approval definition ID​

Confirm that the ID belongs to the current Lark application, that the required permissions are enabled, and that the application is published.