Lyro Action templates – Tidio

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.

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
How to use 'Book a call' template (Calendly)
How to use 'Get order status' template (Shopify)
How to use 'Create a contact' template (Klaviyo)
How to use 'Create a contact' template (Mailchimp)
How to use 'Create a contact' template (HubSpot)

Navigating the templates section

To access your available Action templates, open the Lyro AI Agent section, and head over to Actions:

Inside, you will find two main tabs: My Actions and Templates. Inside the Templates tab, there will be a collection of available Action templates that you can choose from:

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

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)
Get order status (Shopify)
Create a contact (Klaviyo)
Create a contact (Mailchimp)
Create a contact (HubSpot)

💡

Notice that all the templates are in English; no need to worry if you're going to use Lyro with other languages, however! Lyro will translate internally and use any of its supported languages to communicate with your customers. To learn more about Lyro's multilangauge capabilities, please see this dedicated guide.

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.

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:

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.

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

Click on the Edit sequence button to proceed:

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:

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

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:

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

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:

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:

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:

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

Your Lyro Action is ready to be used!

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

Once you're happy with the results, make sure to use the Save Action button at the bottom:

The new Action will now be listed in your My Actions tab. Don't forget to enable the Action with the toggle on the right:

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

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:

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.

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:

Underneath the instructions, you will notice the Input variables section. It lists the required data that Lyro is going to collect from your customer, to allow the exchange of information. The variables already listed cannot be modified, and you do not need to add anything else here.

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:

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:

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

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:

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:

Your Lyro Action is ready to be used!

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

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.

Once you're happy with the results, make sure to use the Save Action button at the bottom:

The new Action will now be listed in your My Actions tab. Don't forget to enable the Action with the toggle on the right:

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.

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:

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 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:

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:

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

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:

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

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

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.

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

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

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

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:

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

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

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

Your Lyro Action is ready to be used!

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

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:

Once you're happy with the results, make sure to use the Save Action button at the bottom:

The new Action will now be listed in your My Actions tab. Don't forget to enable the Action with the toggle on the right:

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.

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:

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.

Underneath the instructions, you will notice the Input variables section. It lists the data that Lyro is able to collect from your visitor before a contact is created. If you wish, you can modify the listed variables, remove some, or add new variables. You can also make sure that certain variables (e.g. the first and last name) are required instead of optional:

Click on the Edit sequence button to proceed:

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:

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

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:

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

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

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

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

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

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:

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

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

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

Your Lyro Action is ready to be used!

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

Once you're happy with the results, make sure to use the Save Action button at the bottom:

The new Action will now be listed in your My Actions tab. Don't forget to enable the Action with the toggle on the right:

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.

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:

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.

Underneath the instructions, you will notice the Input variables section. It lists the data that Lyro is required to collect from your visitor before a contact can be created. If you wish, you can modify the listed variables, remove some, or add new variables. You can also make sure that certain variables (e.g. the first and last name) are required instead of optional:

Click on the Edit sequence button to proceed:

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:

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

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

Open the Development section and head over to Legacy Apps:

Inside, click on the Create button on the right:

Select the Private option for your new legacy app:

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

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

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

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

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

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:

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

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:

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

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

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

Your Lyro Action is ready to be used!

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

Once you're happy with the results, make sure to use the Save Action button at the bottom:

The new Action will now be listed in your My Actions tab. Don't forget to enable the Action with the toggle on the right: