How to Trigger a Lark Base Workflow With a Button

0
3

How to Trigger a Lark Base Workflow With a Button

Some processes are better run on demand than on a schedule.

Instead of waiting for a record to update or a set time to arrive, you can let your team kick off a process themselves with a single click.

Lark Base workflows and automations support setting a button click as a trigger condition, so when a user clicks the button, the linked actions run immediately.

This guide walks you through how to set it up, using the workflow feature as the example. A similar approach applies to automations.

A Lark Base workflow using a button click as the trigger condition

A Lark Base table with button fields that members can click to run a workflow

How the Button Trigger Works

When configuring the “When a button is clicked” trigger in a workflow or automation, you do not need to specify the exact button that triggers the process.

Instead, you define the button type and scope. After configuration, you link the workflow or automation to the button field or block, and one process can be linked to multiple buttons that meet the defined criteria.

There are two types of buttons in Base: those linked to table data, and those not linked to table data. When setting a button click as a trigger condition, you need to select which button type will trigger the process.

Note: When advanced permissions are not turned on, users with edit or manage permissions for the base can set up workflows and automations. When advanced permissions are turned on, only users with manage permissions can do so.

The Two Steps at a Glance

To use a button click as a trigger condition, you complete two steps:

  1. In a workflow or automation, set the trigger condition to When a button is clicked and select the button type for triggering the process.
  2. In the configuration panel of the corresponding button field or block, select the workflow or automation to trigger.

Step 1: Set a Button Click as the Trigger Condition

  1. Open a base file, click Workflow in the lower-left corner, and click Start From Scratch on the canvas.
  2. In the trigger node, select When a button is clicked.

Selecting When a button is clicked from the trigger list in a Lark Base workflow

  1. Select the button type and scope.

Choosing between button field and button block and setting the trigger scope in Lark Base

  • Button field: Select this option if the workflow needs to reference specific data from the table where the button field is located. The workflow will be triggered by a button field in the table. If you choose this option, you also need to specify the table and can optionally define the record scope for triggering the workflow.
  • Button block: Select this option if the workflow should be triggered by any button field or block in the base, including buttons in the Base app that reference data from the current base. Note that workflows triggered by button blocks can only retrieve the data of the user who clicked the button and the time of the click.

Tip: Choose Button field when the action depends on a specific record, such as approving a particular task or sending a message about one row.

Choose Button block for base-wide actions that do not need record data, such as generating a summary or triggering a general notification.

After completing the setup for the trigger, you can proceed to configure the subsequent workflow nodes.

Step 2: Select the Workflow in the Button Field or Block

Open the configuration panel for the button field or block that needs to trigger the workflow, or the configuration panel for the send message node.

In the Action to perform or When a button is clicked menu, select Run Workflow, choose the workflow to run, and save the configuration.

Selecting Run Workflow in the configuration panel of a Lark Base button field

Which workflows are available depends on the button type:

  • Button fields can link to workflows configured with the type set to Button field and the linked table set to the current table, as well as all workflows configured with the type set to Button block.
  • Button blocks can link to all workflows configured with the type set to Button block.

Take the button field as an example.

Double-click the field name of the button field to open the configuration panel, click Select an action > Run Workflow, then select the workflow to run.

After saving, clicking the button will trigger the corresponding workflow.
Note on trigger limits:

  • Workflows triggered by button fields: each button has a limit of 10 triggers per minute.
  • Workflows triggered by button blocks: all such workflows in the entire base share a combined limit of 10 triggers per minute.

Practical Use Cases for SMEs and Startups

  • Approval requests: Add a button to each row so a manager can approve an item and trigger the follow-up actions instantly.
  • Status updates: Let team members mark a task complete and automatically notify the relevant group.
  • Sending reminders: Trigger a message to a customer or colleague straight from the record, without leaving the table.
  • Generating reports: Use a button block on a dashboard to run a summary workflow whenever someone needs the latest figures.

Frequently Asked Questions (FAQ)

How do I trigger a Lark Base workflow with a button?

Set the workflow’s trigger condition to “When a button is clicked” and choose the button type and scope. Then open the configuration panel of the button field or block, select Run Workflow, and choose the workflow you just created.

What is the difference between a button field and a button block?

A button field sits in a table and performs actions on a record, so it can reference that record’s data. A button block sits in a dashboard or app page and performs overall actions, but can only retrieve the identity of the person who clicked and the time of the click.

Can one workflow be triggered by more than one button?

Yes. Because you define the button type and scope rather than a single specific button, one workflow or automation can be linked to multiple buttons that meet the defined criteria.

Who can set up workflows and automations in Base?

When advanced permissions are not turned on, users with edit or manage permissions for the base can set them up. When advanced permissions are turned on, only users with manage permissions can.

Is there a limit on how often a button can trigger a workflow?

Yes. Each button field has a limit of 10 triggers per minute. For button blocks, all such workflows across the entire base share a combined limit of 10 triggers per minute.

Does this work for automations as well as workflows?

Yes. The approach is the same for automations. Set the trigger to “When a button is clicked”, define the button type and scope, then link the automation from the button’s configuration panel.

Put Your Workflows One Click Away

Button triggers turn your bases into something closer to a proper internal tool.

Instead of teaching everyone how a workflow runs, you give them a button and let the automation handle the rest.

For SMEs and startups, it is a straightforward way to make processes accessible to the whole team, not just the person who built them.

Ready to Power Your Business with Lark?

Lark Base is just one part of an all-in-one platform that brings messaging, meetings, documents, approvals, and automations together for your entire team.

As the Platinum Partner for Lark in Malaysia, Exabytes offers tailored Lark plans, hands-on onboarding, and dedicated local support to help your team automate their everyday work.

Explore Lark plans with Exabytes today