You can enlarge all screenshots by clicking on them. The screenshots show the node itself as well as the corresponding settings menu.
Start Conversation
A workflow can start in five ways: when the contact starts a conversation, by an external trigger via webhook call (currently in beta status), by a handoff from a Connect AI Agent, time-based from a date stored on the contact, or manually, when an operator starts the workflow for a contact. You choose the way in the Start node under Trigger type.
Start by new conversation, triggered by the contact
Let's assume you operate a website. Our website chat is embedded on it. A contact starts a conversation via the chat button. A chatbot linked to the workflow guides the customer through the predefined process
This node is included by default in every workflow and cannot be further configured in this status.
Start by external trigger
Now let's assume, on the other hand, that you use a system independent of Lime Connect, based on whose data you want to trigger an automated workflow in Lime Connect.
In this case, it's not the contact who starts the workflow, but a previously defined (programmed) event in your third-party system, which is transmitted to Lime Connect via interface.
If you want to start the workflow through an external trigger, you need programming experience and experience in handling interfaces.
Currently, the webhook trigger can only be used in combination with WhatsApp template nodes.
Here you configure the webhook URL as well as the authorization header. You also specify the expected data fields that will be transmitted to your system.
Use case example (open by clicking the arrow on the left)
Start by handing off from a Connect AI Agent
You can also trigger a handoff of the ongoing conversation from your Connect AI Agent to a workflow. For this, the Start node must be set to the corresponding type.
If needed, you can also pass data that your AI Agent has access to to the workflow. This data will then be available as variables within the workflow.
Start time-based from a contact field
A workflow can also start at a time that is already stored on the contact. The typical case is a birthday message that goes out every year on the contact's birthday.
In the Start node, set Trigger type to Time-based from contact. The other options are When conversation starts, When webhook is called, When Connect AI hands off and Started manually.
Before choosing a field, check that it can be used. Only contact fields with the input type Date or Date and time qualify. The input type of a saved field cannot be changed afterwards, so a birthday held in a text field has to be created again with the input type Date under Settings > Chat tools > Data fields.
Under Run on, click Select contact variable and choose the field that holds the date. The selection offers only the fields that qualify, and the tabs for conversation and workflow variables do not appear at all.
Time of day sets the time the workflow runs at, 9:00 AM unless you change it. Only 30-minute steps can be selected.
Offset shifts the run away from the date itself. Leave it at No offset to run on the date. Choose Before or After to shift it, then give an amount and a unit. A Date field offers days only. A Date and time field also offers minutes and hours, because it carries a time of its own.
Repeat yearly runs the workflow every year on that date. It is off to begin with, so a birthday message needs it switched on. Leave it off for a date that should only ever trigger once, such as a sign-up date.
Start manually by an operator
With the trigger type Started manually, an operator starts the workflow by hand for a specific contact, right from the contact's profile in the Message Center. Use it for flows that should not start on their own but only when someone on your team decides. When starting, the operator can pass in values, for example an order number that the workflow then uses.
Builders set it up in the workflow editor: the Start node, then activating the workflow and connecting a chatbot. Operators then run it from a contact's profile in the Message Center.
Do not confuse this trigger with the start by a new conversation further up: there the contact starts the conversation, here an operator starts the workflow.
When you build the workflow, put Send WhatsApp template message before every node that needs a conversation. A manually started workflow runs for the contact and starts without a conversation. Only this node opens one, by sending the contact an approved WhatsApp template through one of your WhatsApp channels. It is described on the page "Actions nodes". The node after it runs right away and does not wait for a reply.
The template is only sent if you have a WhatsApp channel with an approved template, and if the contact is not blocked and has a mobile number that uses WhatsApp. Without a WhatsApp channel, a manually started workflow can only use nodes that need no conversation.
Of the nodes on this page, Message and Trigger add-on need a conversation. Keyword listener waits for a message from the contact in the conversation. Place all three after the template node. Condition needs no conversation, and neither do nodes that only concern the contact, such as Contact update (page "Actions nodes") or API request (page "Collect Information nodes").
Choose the trigger type before anything else in the Start node: changing it later resets the node and clears every setting of the previous type, including the input variables.
Open the workflow in the workflow editor, click on the Start node and, under Trigger type, select Started manually.
Under Input variables, you define which values the operator enters when starting; if you need none, leave the section empty. For each value, click on Add variable and give the variable a name, for example "order_number". A name may only contain the Latin letters a to z and A to Z, digits, "-" and "_", and each name may only be used once. For each variable you also set:
- Required: When checked, the operator can only start the workflow after entering a value. New variables start out as required.
- Type: String for text, or Number. A Number field only accepts numbers when starting, including decimals and negative numbers. This "Type" decides what the operator may enter; the Trigger type above decides how the workflow starts.
- Description: a hint for the operator about what to enter. They see it when starting, via the info icon next to the field name.
If the operator leaves an optional field empty, the variable stays empty: a Message node shows nothing in its place, and a Send WhatsApp template message node that uses it as a placeholder fails. Make a variable required if a template needs it.
In the nodes after the Start node, you find the input variables in the variable selection on the This Workflow tab, for example "order_number" as a placeholder in a WhatsApp template. Because the workflow runs for a contact, you can also use the contact's fields.
When the workflow is ready, switch on the Active toggle at the top of the workflow editor and confirm with Activate.
Then assign the workflow to a chatbot, as described on the Workflows page under "Assign your workflow to a chatbot": add a chatbot with the bot type "WORKFLOW", or open an existing one. A chatbot has exactly one connected workflow, so choosing this workflow for an existing chatbot replaces its previous one.
Select the workflow under Connected workflow and click on Save. Only active workflows can be selected there, which is why you activate first. Without this chatbot the workflow cannot be started, and messages the workflow sends appear in the conversation as sent by this chatbot.
The following steps are for operators; whoever built the workflow can use them to test it. All operators see the Run Workflow button once Workflows are booked for your account; there is no separate permission for starting.
Open the contact's profile in the Message Center, for example via Contacts in the navigation. The tab row shows Profile, Conversations and, depending on your role, Workflows. On its right you find the Run Workflow button.
Click on Run Workflow. In the window of the same name, select the workflow under Workflow. The list shows all active workflows with the trigger type Started manually. If the workflow has input variables, a field with its name appears for each one, and required fields are marked.
Starting runs the workflow for real: the WhatsApp template goes to the contact. To test, use a contact with your own mobile number. Each click on Start starts another run. A single run cannot be stopped from the contact profile; runs can only be stopped all at once, by deactivating the workflow with "Stop active runs & deactivate".
Fill in the fields and click on Start. Optional fields left empty are not passed on.
After the start, you see the notice "Workflow started". The contact notices nothing until the workflow sends them something, such as the WhatsApp template.
To check whether it worked, open the Workflows tab of the contact profile. Only operators whose role may view workflows see it; if you do not, ask someone who can. Each run is listed with its status: Active, Waiting, Finished or Error. Click on the workflow name to open the Workflow Activity with its Execution log; Show details on a step shows the node and its error.
If you cannot start a workflow:
- You do not see "Run Workflow": Workflows are not booked for your account.
- "There are no active workflows with a manual trigger. Create and activate one in the workflow builder to run it here.": No workflow has both the trigger type Started manually and the status Active. Ask whoever built the workflow to activate it.
- "To run this workflow, connect a workflow bot to it in the chatbot settings." after clicking on Start: No chatbot has this workflow as its Connected workflow. Whoever built the workflow needs to assign it to a chatbot, as described on the Workflows page under "Assign your workflow to a chatbot".
- "Start" stays greyed out: No workflow is selected yet, or a required field is still empty.
- "Please enter a number.": The field belongs to a variable of type Number. Enter a number only.
If a run shows Error, the Execution log names the node that failed. Common causes and their fixes:
- A Message or Trigger add-on node came before the template: Place Send WhatsApp template message before it.
- The contact is blocked: Templates are not sent to blocked contacts.
- The contact has no mobile number: Add the mobile number in the contact profile and start again.
- The mobile number does not use WhatsApp: Check the number in the contact profile.
- The WhatsApp channel is locked or invalid: Check the WhatsApp channel in your channel settings.
- The template chosen in the node is not approved on its WhatsApp channel: Choose an approved template in the node.
- A template placeholder stayed empty, for example from an empty optional input variable: Make the variable required, or fill in the field when starting.
- The contact's WhatsApp conversation already has an active workflow: Wait until that workflow has finished, then start again.
If the Start node shows an error:
- "This field must only use alphanumeric characters, “-” or “_”.": The variable name contains another character, such as a space or "ä". Rename the variable.
- "This variable name is already used.": Two input variables have the same name. Rename one of them.
Condition
Use this node when you want to offer different paths based on a condition for the contact.
In our example: All contacts whose email address includes "company1" go path A, all other contacts go path B.
The conditions are executed by the system from top to bottom until a condition applies. All conditions after that are no longer executed.
Keyword listener
Use this node when you want to perform an action based on keywords you have defined.
In our example: As soon as the contact sends the keyword "Support", the action connected afterward is triggered.
In a manually started workflow, this node waits for a message from the contact in the conversation, so place it after the "Send WhatsApp template message" node, see "Start manually by an operator".
Message
Use this node when you want to display one or more text blocks to your contacts. You can also add buttons or media.
In our example: After the text is displayed, the contact is shown two clickable buttons that lead them to the stored URL.
In a manually started workflow, this node only works after a WhatsApp template has opened the conversation; otherwise the run ends with "Error". See "Start manually by an operator".
Trigger add-on
Use this node when you want to trigger an add-on offered by us during the conversation.
In our example: The Lime CRM add-on is triggered and the conversation is converted into a Lime CRM object. This happens in the background.
In a manually started workflow, this node only works after a WhatsApp template has opened the conversation; otherwise the run ends with "Error". See "Start manually by an operator".
Delay
Use this node when the workflow should wait for a while before the next node runs. Under Wait time, enter a whole number and choose the unit: Seconds, Minutes, Hours or Days.
To take the wait time from a variable instead, switch on Use variable and select a variable that holds the wait time in seconds. If a fixed wait time is longer than 24 hours and a node that sends a message follows, the editor shows a warning: WhatsApp does not allow free-form messages more than 24 hours after the last message from the contact, so use a WhatsApp template instead.