# Lyro Action templates

Section: Lyro - AI Agent

Description: Find Lyro's ready-made Action templates, add one in a click or customize it, and set up the Calendly, Shopify, Klaviyo, Mailchimp and HubSpot templates step by step.

Verified against Tidio panel 12.304.0

Last updated: 2026-11-09

Source: https://help.tidio.com/articles/lyro-action-templates/

Lyro** Actions** are a powerful tool that allow Lyro to connect with external systems and communicate back and forth, making use of **API**. There are a number of templates available, letting you quickly set up specific integrations with 3rd-party apps (e.g. Calendly, Shopify, or Mailchimp, among others).



If you are not familiar with Lyro Actions in general, we highly recommend that you (or your developer) learn more about this feature. For details, please see [this comprehensive guide](<https://help.tidio.com/articles/lyro-actions/>).







Action templates are available to all subscribers of the **Plus** and **Premium** packages, as well as selected subscribers of the **Lyro AI Agent **package (this tool is still being tested and developed before a full, wide release is possible).







**In this article, you will learn:**



- [How to navigate your Action templates](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN0VK8DVKCEM78JVWH5QT>)
- [How to use 'Book a call' template (Calendly)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN2RAC83N2V29N8M57X9Z>)
- [How to use 'Get order status' template (Shopify)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN4P07GFQ4T2VHMK1X4GK>)
- [How to use 'Create a contact' template (Klaviyo)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN76TWXWDHAWV710XASP1>)
- [How to use 'Create a contact' template (Mailchimp)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN9E43Q0AZBTVKYWASAG9>)
- [How to use 'Create a contact' template (HubSpot)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CNC4H7XGHCSS922TWFEXZ>)



[Video](<https://help.tidio.com/article-media/lyro-action-templates/walkthrough.mp4>)



Silent walkthrough. Create the Book a call in Calendly Action from a template: open its sequence, add a Calendly token to the API call and test the request, save the sequence and activate the Action.











## Navigating the templates section







To access your available Action templates, open the **Lyro AI Agent** section, and head over to **Behavior \> Actions & MCPs**:









![The Lyro sidebar has Behavior expanded and "Actions & MCPs" selected.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-30720323043356.webp>)









Inside the **Actions** tab there, at the bottom (under **Explore how Lyro can do more with templates**), there will be a collection of available Action **templates** that you can choose from. You can also jump straight there with the **Create** button in the top-right - just select **Create from template**:









![The action template gallery offers Calendly bookings, contacts in HubSpot, Mailchimp, or Klaviyo, product questions, and "Request template".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-30720323044380.webp>)![Behavior \> Actions & MCPs with the Create dropdown open in the top-right, showing Create from scratch, Create from template (highlighted) and Import, and Add MCP server below a separator](<https://help.tidio.com/article-media/lyro-action-templates/57.1.png>)









Hover your mouse cursor over any template that you're interested in, and you will see the **Learn more** button appear - to use the template, click on that button:









![An action template card displays a "Learn more" button.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23138155915036.webp>)









Next, you will need to follow the steps necessary for each template's proper setup. Feel free to use the list below for more details on each available template:



- [Book a call (Calendly)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN2RAC83N2V29N8M57X9Z>)
- [Get order status (Shopify)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN4P07GFQ4T2VHMK1X4GK>)
- [Create a contact (Klaviyo)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN76TWXWDHAWV710XASP1>)
- [Create a contact (Mailchimp)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CN9E43Q0AZBTVKYWASAG9>)
- [Create a contact (HubSpot)](<https://help.tidio.com/articles/lyro-action-templates/#h_01K88CNC4H7XGHCSS922TWFEXZ>)



Most templates open with the **Use template** button, which takes you straight to the Action editor. Some templates are ready to go as they are, and show two buttons instead: **Activate** adds the Action and switches it on right away, while **Customize template** opens it in the editor first, just like **Use template**. If a template still needs some setup from you, **Activate** will tell you: **This template needs additional configuration. Customize it to continue.**

![The window of a template that can be activated right away: the template's name, the Activate and Customize template buttons below it, the description, the Steps list, and the note "This template is here to help you get started. You’re free to adjust it, just double-check that everything works as expected.", with the preview on the right](<https://help.tidio.com/article-media/lyro-action-templates/57.2.png>)

At the end of the templates, you'll also find two more tiles: **Answer product related questions**, whose **Add products** button takes you to Lyro's **Products** page (the tile disappears once Product Recommendations are switched on), and **Haven’t found what you want?**, where you can use **Request template** to tell us which template you're missing.







💡

 

Notice that all the templates are in **English**; no need to worry if you're going to use Lyro with other languages, however\! As the note above the templates says, Lyro speaks all supported languages and answers your visitors in their language. You can also edit the templates, or create your own Actions in your preferred language. To learn more about Lyro's multilanguage capabilities, please see [this dedicated guide](<https://help.tidio.com/articles/lyro-multilanguage-support/>).







## Book a call (Calendly)







With this template, Lyro connects with **Calendly** API and is able to provide your chat visitor with the appropriate link - so they can schedule an appointment with you.









![The "Book a call (Calendly)" template offers visitors a personalized scheduling link when they ask to book a call.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23138222165020.webp>)









Once you click on the **Learn more** button for this template, you will see a general description of what the template allows you to do, as well as an example interaction between Lyro and a customer:









![The Calendly template dialog provides "Use template", explains the booking steps, and previews Lyro sharing a "Schedule Now" link.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23138222168092.webp>)









Click on the **Use template** button to start the setup. This will take you to the Action **editor**, where all the necessary (and optional) steps can be configured.



The Action's **name** and **instructions** will be pre-filled, as a good starting point. Naturally, you can modify these things to your preference.









![The "Edit Smart Action" page has "Book a call (Calendly)" and detailed booking instructions prefilled.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23138235698204.webp>)









Most importantly, take a look at the **instructions** field. That is the prompt that Lyro will use to trigger the Action during a chat, and how to behave in detail. Make sure to customize these instructions to suit your needs, and be as detailed as you can - especially regarding **when to trigger** the action:









![The Instructions field explains when the Calendly action should trigger, with sample requests to book a call, consultation, or meeting.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23138235699868.webp>)









The next step is to **edit** and **save** your **Action sequence**, found underneath the instructions. The **Action sequence** is modified inside its own editor, and is composed of specific **steps** that the Action performs (once triggered). You need to configure this to suit your specific needs as well.



Until you do, you'll see a reminder under **Action sequence**: **Click Edit sequence to review and complete the setup. Then save to activate the Action.**



Click on the **Edit sequence** button to proceed:









![The Action sequence section highlights a draft sequence with "Edit sequence" and instructions to configure and test its HTTP request before activation.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23138235701020.webp>)









Once inside the editor, you will notice that the **API call** node requires your attention. Click on it, and you will notice that the **request** hasn't been completed yet. The request is what connects Lyro with the external system (Calendly, in this case) and allows the exchange of data.



Click on the **Configure HTTP request** button to proceed:









![The API call node has an error indicator, and its settings say the request is incomplete above "Configure HTTP request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23138222171676.webp>)









Inside, you will see that the** Bearer token** is missing - it is the field highlighted in red:









![The HTTP request form has Bearer authentication selected and an empty Bearer token field marked "Field is required".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139375289884.webp>)









It is a security measure necessary for the integration. To get it, you need to go to your **Calendly** account, and in the** Integrations & apps** section - click on **API and webhooks**:









![The Calendly Integrations & apps page has an arrow pointing to the "API and webhooks" card.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139345397148.webp>)









In the **Your personal access tokens** section there, click on the **Generate New Token** button:









![The Calendly personal access tokens section offers "Generate New Token" and warns that admin tokens grant organization-wide data access.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139345397660.webp>)









You will be asked to **name** your new token and **verify** it. Once that is done, you will be able to **copy** the new token:









![The personal access token dialog displays a masked token and "Copy token", warning that the token cannot be accessed again.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139345398428.webp>)









Back in the **HTTP request **editor, paste the token you've just copied into the **Bearer token** field.



The last step is to **test** the request; to do that, click on the **Test request **button at the bottom:









![The Calendly request has a masked Bearer token and GET configuration, with an arrow pointing toward "Test request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139345399708.webp>)









If everything is correct, you should see a correct response in the **Response** field on the right.



Now you can hit the **Add request** button at the bottom:









![The request editor shows "Test request" beside an enabled "Add request" button.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139375293980.webp>)









... and then, the **Save and close** button in the top-right of your **Action sequence** editor:









![The action sequence editor shows "Close" and "Save and close" in the upper-right corner.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139375294876.webp>)









Your Lyro **Action** is ready to be used\!



Finally, you can test your new Action by clicking the **Test it out** button at the bottom of the Action editor. This lets you chat with Lyro and test out its new Action in a controlled environment:









![The Test Action chat shows Lyro responding to a booking request with a "Schedule Now" link.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139550187548.webp>)









Once you're happy with the results, hit the **Activate** button at the bottom to save the Action and switch it on right away - or **Save and close** to save it and switch it on later:









![The bottom of the Action editor of a template-based Action, with the Cancel button on the left and the Test it out, Save and close and Activate buttons on the right](<https://help.tidio.com/article-media/lyro-action-templates/57.3.png>)









The new Action will now be listed in the **Actions** tab. If you used **Save and close**, don't forget to **enable** the Action with the switch in the **Active** column:









![The Actions tab of Behavior \> Actions & MCPs (the Actions and MCPs tabs at the top) with the new "Book a call" Action in the list and its switch in the Active column turned on](<https://help.tidio.com/article-media/lyro-action-templates/57.4.png>)









## Get order status (Shopify)







With this template, Lyro connects with your** Shopify **store's API and is able to provide your customer with details regarding their order, including the URL for tracking their package. For this to work, your Tidio project needs to be integrated with your Shopify store (although you will get the option to integrate directly from this template, as part of its setup, if necessary).









![The "Get order status (Shopify)" template card describes checking payment, fulfillment, purchased products, and tracking details in chat.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159789996828.webp>)









Once you click on the **Learn more** button for this template, you will see a general description of what the template allows you to do, as well as an example interaction between Lyro and a customer:









![The Shopify order-status template dialog offers "Use template" and previews Lyro requesting a postal code to authenticate an order inquiry.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159789999132.webp>)









Click on the **Use template** button to start the setup. This will take you to the Action **editor**, where all the necessary (and optional) steps can be configured.



The Action's **name** and **instructions** will be pre-filled, as a good starting point. Naturally, you can modify these things to your preference.









![The "Edit Smart Action" page has "Get order status (Shopify)" and order-status instructions prefilled.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159815590300.webp>)









Most importantly, take a look at the **instructions** field. That is the prompt that Lyro will use to trigger the Action during a chat, and how to behave in detail. While you are free to customize these instructions to suit your needs, we recommend that you do not change the instructions significantly at this stage. If you do, make sure to be as detailed as you can - especially regarding **when to trigger** the action:









![The Instructions field defines order-status trigger phrases and explains Shopify payment and fulfillment statuses.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159815590812.webp>)









The data that Lyro is going to collect from your customer, to allow the exchange of information (the **input variables**), is set in the first step of the **Action sequence** below - the **Collect information** step. For this template, it holds the **Order ID** and the **Customer email**. These variables cannot be modified (they're required by the **Get order details** step), and you do not need to add anything else here.









![The Action sequence editor of a Check order status Action with a Shopify Get order details step: the trigger step Lyro collects 3 variables is selected, its Collect information list on the right shows Order ID, Customer email and Zip code greyed out, and the tooltip "Required by Shopify node" is open](<https://help.tidio.com/article-media/lyro-action-templates/57.5.png>)









The next required step is to **verify** and **save** your **Action sequence**, found lower in the Action editor. The **Action sequence** is modified inside its own editor, and is composed of specific **steps** that the Action performs (once triggered). You need to access the editor to simply **verify** it, although you can modify the sequence if you so choose.



Click on the **Edit sequence** button to proceed:









![The Action sequence section highlights the draft and its "Edit sequence" button, with a reminder to review and save before activation.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159815593628.webp>)









Inside the editor, if you see no alerts or error messages, simply click on the **Save and close** button in the top-right in order to verify the setup:









![The sequence connects "Lyro starts an action" to "Get order details", with an arrow pointing to "Save and close".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159790005276.webp>)









However, if you wish, you can click on the** Get order details** node and make one change that may better suit your needs:









![The Get order details settings show a verification dropdown with "Zip code", "Phone number", and "None" options.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159815595804.webp>)









You can decide whether Lyro asks for the customer's **zip code** (the default), their **phone number**, or **nothing**. Note that the customer is always asked for their **email** and **order ID**, regardless of this setting.







Please note: if you haven't integrated Tidio with your Shopify store yet, you can do that at this stage. If you're not yet connected, the **Get order details** node will give you the option to **integrate**:









![The Get order details node displays a Shopify connection requirement and an "Integrate with Shopify" button.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159815596572.webp>)









Once you are done with verifying and/or customizing the sequence, hit the **Save and close** button in the top-right of your **Action sequence** editor:









![The action sequence editor shows "Close" and "Save and close" in the upper-right corner.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139375294876.webp>)









Your Lyro **Action** is ready to be used\!



Finally, you can test your new Action by clicking the **Test it out** button at the bottom of the Action editor. This lets you chat with Lyro and test out its new Action in a controlled environment:









![The Test Action chat shows Lyro asking for a shipping postal code after receiving the visitor’s order ID and email.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159851268252.webp>)









Note how Lyro lays out the available information (order details, tracking link, etc.). If you do not like the way some information is presented, you may want to go back to the **Instructions** section and modify the prompt to your preference, and test again.









![The Test Action chat shows Lyro confirming a paid and fulfilled order, listing purchased products, and sharing a "Track your package" link.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23159851269532.webp>)









Once you're happy with the results, hit the **Activate** button at the bottom to save the Action and switch it on right away - or **Save and close** to save it and switch it on later:



















The new Action will now be listed in the **Actions** tab. If you used **Save and close**, don't forget to **enable** the Action with the switch in the **Active** column:



















## Create a contact (Klaviyo)







With this template, Lyro connects with **Klaviyo** API and is able to save your visitor's details as a contact in Klaviyo. Lyro can ask for the necessary information (e.g. name and email) when the visitor wants to subscribe, or if they express their willingness in some other way.









![The "Create a contact (Klaviyo)" template card describes collecting visitor details and adding subscribers to a Klaviyo mailing list.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23160669490204.webp>)









Once you click on the **Learn more** button for this template, you will see a general description of what the template allows you to do, as well as an example interaction between Lyro and a customer:









![The Klaviyo contact template dialog offers "Use template", outlines collecting a first name and email, and previews a newsletter signup conversation.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23160661394972.webp>)









Click on the **Use template** button to start the setup. This will take you to the Action **editor**, where all the necessary (and optional) steps can be configured.



The Action's **name** and **instructions** will be pre-filled, as a good starting point. Naturally, you can modify these things to your preference.









![The Klaviyo action editor has prefilled subscription instructions and required first-name and email input variables.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23160669492508.webp>)









Most importantly, take a look at the **instructions** field. That is the prompt that Lyro will use to trigger the Action during a chat, and how to behave in detail. Make sure to customize these instructions to suit your needs, and be as detailed as you can - especially regarding **when to trigger** the action (e.g. when the visitor wants to be part of your newsletter, or if they want to access certain resources):









![The Instructions field tells Lyro to collect a subscriber’s email and first name, create or update their Klaviyo profile, and confirm success.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23160661395868.webp>)









The data that Lyro is required to collect from your visitor before a contact can be created (the **input variables**) is set in the first step of the **Action sequence** - the **Collect information** step. Once you open the sequence (see below), click on that step if you wish to modify the listed variables, remove some, or add new ones with **Add variable**:









![The Action sequence editor of the Create a contact (Klaviyo) template with the Collect information step selected, its settings on the right listing the template's variables and the Add variable button](<https://help.tidio.com/article-media/lyro-action-templates/57.6.png>)









The next required step is to **edit** and **save** your **Action sequence**, found underneath the instructions. The **Action sequence** is modified inside its own editor, and is composed of specific **steps** that the Action performs (once triggered). You need to configure this to suit your specific needs as well.



Click on the **Edit sequence** button to proceed:









![The Action sequence section highlights "Edit sequence" and explains adding the Klaviyo private API key, testing the request, and saving.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130255516.webp>)









Once inside the editor, you will notice that the **API call** node requires your attention. Click on it, and you will notice that the **request** hasn't been completed yet. The request is what connects Lyro with the external system (Klaviyo, in this case) and allows the exchange of data.



Click on the **Configure HTTP request** button to proceed:









![The API call node has an error indicator and an incomplete-request warning above "Configure HTTP request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173266588.webp>)









Inside the request editor, you will notice that the **API key** field is empty:









![The "Create profile in Klaviyo" request has API key authentication selected and an empty required key field above preconfigured headers.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173267228.webp>)









You will need to get this **API key** from your **Klaviyo** account.



In **Settings**, open the **Account** tab, and go to the **API keys** section:









![The Klaviyo Settings page has Account selected and an arrow pointing to "API keys".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173268508.webp>)









Inside, click on the **Create Private API Key** button on the right in order to create a new key for your Lyro Action:









![The Klaviyo Private API Keys page has an arrow pointing to "Create Private API Key".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130262812.webp>)









**Name** your new API key, and select the **Custom Key** option underneath:









![The Create Private API Key form has a name field and "Custom Key" selected instead of Read-Only Key or Full Access Key.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173272092.webp>)









In the column on the right, find the access options for **Profiles**, and select **Full Access**. This is required for Lyro to be able to get information from Klaviyo as well as create new contacts; we recommend you do not change any other options, however.









![The Profiles permissions row is outlined, with "Full Access" selected.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130264348.webp>)









Once you're done, click the **Create** button in the top-right:









![The Klaviyo key creation page shows "Cancel" and "Create", with the pointer on "Create".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130266652.webp>)









You will now see your new **API key**. **Copy** it in full, using the dedicated button:









![The new private key panel has copy and download buttons and warns that the key is visible only once and should be stored securely.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173278364.webp>)









Back in your Tidio project's **request editor**, paste the API key you've just copied into the **API key** field:









![The HTTP request’s API key authentication is selected and the key field contains a masked value.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130269212.webp>)









Now that the key is in place, you should use the **Test request **option at the bottom of the editor, which will use the **test values **that you can see (and modify) above it, for testing purposes:









![The JSON request body uses email and first-name variables, with test values below and an arrow pointing to "Test request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173280668.webp>)









If everything is correct, the **Response** field on the right should display all the processed data with no errors:









![The Response panel shows a successful 201 status and JSON data for the newly created Klaviyo profile.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130271900.webp>)









Once you're done with this initial test, hit the **Add request** button at the bottom to save your changes:









![The request editor shows "Test request" beside an enabled "Add request" button.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130273692.webp>)









... and then, the **Save and close** button in the top-right of your **Action sequence** editor:









![The action sequence editor shows "Close" and "Save and close" in the upper-right corner.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139375294876.webp>)









Your Lyro **Action** is ready to be used\!



Finally, you can test your new Action by clicking the **Test it out** button at the bottom of the Action editor. This lets you chat with Lyro and test out its new Action in a controlled environment:









![The Test Action chat shows Lyro collecting a visitor’s first name and email to subscribe them to a newsletter.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173285020.webp>)









Note that you can click on the **Review sources** link underneath Lyro's response, and you will see all the associated** input values**, the **request**, and the end **result**. This lets you verify that everything has worked correctly in this particular interaction:









![An arrow points from "Review sources" to the outlined action details, where the Klaviyo request and action result both have success checks.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130276508.webp>)









Once you're happy with the results, hit the **Activate** button at the bottom to save the Action and switch it on right away - or **Save and close** to save it and switch it on later:



















The new Action will now be listed in the **Actions** tab. If you used **Save and close**, don't forget to **enable** the Action with the switch in the **Active** column:



















## Create a contact (Mailchimp)







With this template, Lyro connects with **Mailchimp** API and is able to save your visitor's details as a contact in Mailchimp. Lyro can ask for the necessary information (e.g. name and email) when the visitor wants to subscribe, or if they express their willingness in some other way.









![The "Create a contact (Mailchimp)" template card describes collecting visitor details and adding subscribers to a Mailchimp list.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161665194780.webp>)









Once you click on the **Learn more** button for this template, you will see a general description of what the template allows you to do, as well as an example interaction between Lyro and a customer:









![The Mailchimp template dialog offers "Use template", outlines subscriber creation, and previews Lyro requesting an email address for newsletter signup.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161675302428.webp>)









Click on the **Use template** button to start the setup. This will take you to the Action **editor**, where all the necessary (and optional) steps can be configured.



The Action's **name** and **instructions** will be pre-filled, as a good starting point. Naturally, you can modify these things to your preference.









![The Mailchimp action editor has a prefilled name and instructions defining signup triggers, contact creation, and required email input.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161675302940.webp>)









Most importantly, take a look at the **instructions** field. That is the prompt that Lyro will use to trigger the Action during a chat, and how to behave in detail. Make sure to customize these instructions to suit your needs, and be as detailed as you can - especially regarding **when to trigger** the action (e.g. when the visitor wants to be part of your newsletter, or if they want to access certain resources):









![The Instructions field lists newsletter and free-resource requests as triggers, requires an email address, and makes first and last names optional.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161675303196.webp>)









The data that Lyro is able to collect from your visitor before a contact is created (the **input variables**) is set in the first step of the **Action sequence** - the **Collect information** step. Once you open the sequence (see below), click on that step if you wish to modify the listed variables, remove some, or add new ones. You can also make sure that certain variables (e.g. the first and last name) are **required** instead of optional:









![The Action sequence editor of the Create a contact (Mailchimp) template with the Collect information step selected, its settings on the right listing the template's variables (with the first and last name among them) and the Add variable button](<https://help.tidio.com/article-media/lyro-action-templates/57.7.png>)









The next required step is to **edit** and **save** your **Action sequence**, found underneath the instructions. The **Action sequence** is modified inside its own editor, and is composed of specific **steps** that the Action performs (once triggered). You need to configure this to suit your specific needs as well.



Click on the **Edit sequence** button to proceed:









![The Action sequence section highlights "Edit sequence" and explains configuring the Mailchimp token, audience ID, and data-center region before testing.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161675304732.webp>)









Once inside the editor, you will notice that the **API call** node requires your attention. Click on it, and you will notice that the **request** hasn't been completed yet. The request is what connects Lyro with the external system (Mailchimp, in this case) and allows the exchange of data.



Click on the **Configure HTTP request** button to proceed:









![The API call node shows an error indicator and an incomplete-request warning above "Configure HTTP request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161665198876.webp>)









Inside the request editor, you will notice that the **Bearer token** field is empty:









![The Mailchimp HTTP request has Bearer authentication selected and an empty required token field above its POST method and URL.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161665199516.webp>)









You will need to get this **token** from your **Mailchimp** account.



Click on your **avatar** in the top-right, and go to your **Account & billing** section:









![The Mailchimp profile menu is open, with an arrow pointing to "Account & billing".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161675308700.webp>)









Inside, open the **Extras** menu and click on **API keys**:









![The Mailchimp account page has the Extras menu open and "API keys" highlighted.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161665205276.webp>)









Inside, find the **Your API keys** section and hit the **Create A Key** button at the bottom:









![The Mailchimp "Your API keys" list has an arrow pointing to "Create A Key" beneath the existing keys.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161771113244.webp>)









**Name** your new key, and hit the **Generate Key** button:









![The "Name New API Key" page has an API Key Name field and "Generate Key", with a warning that the full key is shown only immediately after generation.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161771114524.webp>)









You will now see your new **API key**. **Copy** it in full, using the dedicated button:









![The "Copy New API Key" page offers "Copy To Clipboard" and "Done", warning that the key cannot be viewed or copied again.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161771115548.webp>)









Back in your Tidio project's **request editor**, paste the API key you've just copied into the **Bearer token** field:









![The request authentication settings have "Bearer" selected and a masked value entered in the "Bearer token" field.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161820275228.webp>)









Now that the key is in place, you should use the **Test request **option at the bottom of the editor, which will use the **test values **that you can see (and modify) above it, for testing purposes:









![The request editor shows a JSON contact payload and test values for email and names, with an arrow pointing to "Test request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161820276636.webp>)









If everything is correct, the **Response** field on the right should display all the processed data with no errors:









![The Response panel shows a successful 200 status and JSON contact details, including a "subscribed" status.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161820278556.webp>)









Once you're done with this initial test, hit the **Add request** button at the bottom to save your changes:









![The request editor shows "Test request" beside an enabled "Add request" button.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130273692.webp>)









... and then, the **Save and close** button in the top-right of your **Action sequence** editor:









![The action sequence editor shows "Close" and "Save and close" in the upper-right corner.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139375294876.webp>)









Your Lyro **Action** is ready to be used\!



Finally, you can test your new Action by clicking the **Test it out** button at the bottom of the Action editor. This lets you chat with Lyro and test out its new Action in a controlled environment:









![The "Test Action" chat shows Lyro asking for an email to subscribe a visitor, followed by the visitor supplying contact details and Lyro typing.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161820280604.webp>)









Note that you can click on the **Review sources** link underneath Lyro's response, and you will see all the associated** input values**, the **request**, and the end **result**. This lets you verify that everything has worked correctly in this particular interaction:









![The highlighted "Review sources" panel shows the Mailchimp contact action, with input values and successful request and action-result indicators.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161813285660.webp>)









Once you're happy with the results, hit the **Activate** button at the bottom to save the Action and switch it on right away - or **Save and close** to save it and switch it on later:



















The new Action will now be listed in the **Actions** tab. If you used **Save and close**, don't forget to **enable** the Action with the switch in the **Active** column:



















## Create a contact (HubSpot)







With this template, Lyro connects with **HubSpot** API and is able to save your visitor's details as a contact in HubSpot. Lyro can ask for the necessary information (e.g. name and email) when the visitor wants to subscribe, or if they express their willingness in some other way.









![The "Create a contact (HubSpot)" template card describes adding chat visitors to the HubSpot CRM.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162755473308.webp>)









Once you click on the **Learn more** button for this template, you will see a general description of what the template allows you to do, as well as an example interaction between Lyro and a customer:









![The "Create a contact in HubSpot" template dialog has a "Use template" button, contact-collection steps, and a sample newsletter subscription conversation.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162762929436.webp>)









Click on the **Use template** button to start the setup. This will take you to the Action **editor**, where all the necessary (and optional) steps can be configured.



The Action's **name** and **instructions** will be pre-filled, as a good starting point. Naturally, you can modify these things to your preference.









![The "Edit Smart Action" form is pre-filled for creating a HubSpot contact, with instructions to collect and validate visitor details before calling the API.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162755476252.webp>)









Most importantly, take a look at the **instructions** field. That is the prompt that Lyro will use to trigger the Action during a chat, and how to behave in detail. Make sure to customize these instructions to suit your needs, and be as detailed as you can - especially regarding **when to trigger** the action (e.g. when the visitor wants to be part of your newsletter, or if they want to access certain resources):









![The focused instructions field triggers the HubSpot action on subscription requests, collects an email and optional names, validates input, and handles API success or failure.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162755479964.webp>)









The data that Lyro is required to collect from your visitor before a contact can be created (the **input variables**) is set in the first step of the **Action sequence** - the **Collect information** step. Once you open the sequence (see below), click on that step if you wish to modify the listed variables, remove some, or add new ones. You can also make sure that certain variables (e.g. the first and last name) are **required** instead of optional:









![The Action sequence editor of the Create a contact (HubSpot) template with the Collect information step selected, its settings on the right listing the template's variables and the Add variable button](<https://help.tidio.com/article-media/lyro-action-templates/57.8.png>)









The next required step is to **edit** and **save** your **Action sequence**, found underneath the instructions. The **Action sequence** is modified inside its own editor, and is composed of specific **steps** that the Action performs (once triggered). You need to configure this to suit your specific needs as well.



Click on the **Edit sequence** button to proceed:









![The "Action sequence" section shows a saved draft and "Edit sequence", with a notice to replace the API key using the HubSpot panel and save.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162762933532.webp>)









Once inside the editor, you will notice that the **API call** node requires your attention. Click on it, and you will notice that the **request** hasn't been completed yet. The request is what connects Lyro with the external system (HubSpot, in this case) and allows the exchange of data.



Click on the **Configure HTTP request** button to proceed:









![The API call node has an error indicator and an incomplete-request warning above "Configure HTTP request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161173266588.webp>)









Inside the request editor, you will notice that the **Bearer token** field is empty:









![The "Configure HTTP request" form for creating a HubSpot contact has "Bearer" selected and an empty token field marked "Field is required".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162755484956.webp>)









You will need to get this **token** from your **HubSpot** account.



Open the **Development** section and head over to **Legacy Apps**:









![The HubSpot Development menu is open, with an arrow and cursor pointing to "Legacy Apps".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162816564892.webp>)









Inside, click on the **Create** button on the right:









![The HubSpot "Legacy Apps" page lists an existing private app, with an arrow and cursor pointing to "Create" in the upper-right.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162807215004.webp>)









Select the **Private** option for your new legacy app:









![The "Create Legacy App" dialog has the "Private" option circled beneath a warning that legacy apps will not receive future updates.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162807217820.webp>)









In the Basic info tab, you can **name** the legacy app and give it an optional **description**, and even a **logo**:









![The HubSpot app’s "Basic info" tab contains a generated name, an "Upload logo" option, and an empty description field.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162807218588.webp>)









Go to the **Scopes** tab, and click the **Add new scope** button:









![The HubSpot "Scopes" tab has no selected scopes, with an arrow pointing to "Add new scope".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162807220636.webp>)









In the panel that appears, search for scopes that include the word '**contact**', and **select** the four scopes as shown in the screenshot below:









![The scope selector highlights checked contact read and write permissions for both CRM objects and CRM schemas.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162918612124.webp>)









Once you're done, hit the **Update** button at the bottom:









![The scope selection panel has the cursor on "Update", beside "Cancel".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162918616092.webp>)









Next, hit the **Create app** button in the top-right:









![The HubSpot app editor has the cursor on the "Create app" button in the upper-right.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162918617244.webp>)









You will now be see your new **access token**. In the **Auth** tab of your newly-created app, click the **Show token** option, which will allow you to **copy** it:









![The app’s "Auth" tab shows masked credentials, with an arrow and cursor pointing to "Show token" beneath "Access token".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162918618524.webp>)









Back in your Tidio project's **request editor**, paste the token you've just copied into the **Bearer token** field:









![The request authentication settings have "Bearer" selected and a masked token entered in the focused "Bearer token" field.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162918620060.webp>)









Now that the token is in place, you should use the **Test request **option at the bottom of the editor, which will use the **test values **that you can see (and modify) above it, for testing purposes:









![The HubSpot request editor has a JSON body with email and name parameters and sample test values, with an arrow pointing to "Test request".](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162918620956.webp>)









If everything is correct, the **Response** field on the right should display all the processed data with no errors:









![The Response panel shows a successful 201 status and JSON properties for the newly created HubSpot contact.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162911293980.webp>)









Once you're done with this initial test, hit the **Add request** button at the bottom to save your changes:









![The request editor shows "Test request" beside an enabled "Add request" button.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130273692.webp>)









... and then, the **Save and close** button in the top-right of your **Action sequence** editor:









![The action sequence editor shows "Close" and "Save and close" in the upper-right corner.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23139375294876.webp>)









Your Lyro **Action** is ready to be used\!



Finally, you can test your new Action by clicking the **Test it out** button at the bottom of the Action editor. This lets you chat with Lyro and test out its new Action in a controlled environment:









![The "Test Action" chat shows Lyro collecting a visitor’s email and first name, then offering to subscribe them to the newsletter.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23162918624156.webp>)









Note that you can click on the **Review sources** link underneath Lyro's response, and you will see all the associated** input values**, the **request**, and the end **result**. This lets you verify that everything has worked correctly in this particular interaction:









![An arrow points from "Review sources" to the outlined action details, where the Klaviyo request and action result both have success checks.](<https://help.tidio.com/article-media/lyro-action-templates/legacy-23161130276508.webp>)









Once you're happy with the results, hit the **Activate** button at the bottom to save the Action and switch it on right away - or **Save and close** to save it and switch it on later:



















The new Action will now be listed in the **Actions** tab. If you used **Save and close**, don't forget to **enable** the Action with the switch in the **Active** column:















## Further reading



- [Lyro Actions](<https://help.tidio.com/articles/lyro-actions/>)
- [Lyro Multilanguage support](<https://help.tidio.com/articles/lyro-multilanguage-support/>)
- [Lyro Procedures](<https://help.tidio.com/articles/lyro-procedures/>)
- [Test Lyro before it goes live](<https://help.tidio.com/articles/test-lyro/>)
