Streamline Connector & Template Installation Guide

Modified on Sun, 4 Aug at 10:30 PM

Requirements:

This guide requires a Voiceflow account and Streamline Connector installed in your Shopify store. ‍
‍
1. Install Streamline Connector to your Shopify Store

First, install Streamline Connector to your Shopify Store. Once installed, you'll notice a banner indicating that your data is syncing with our database. This process ensures that your store data is synced, allowing the assistant easy access without repeated Shopify API calls. This process typically takes 5 to 15 minutes, depending on the size of your store's data.

2. Getting the template

For this guide, we're using the 'Order Retrieval, Product Recommendations & Zendesk Template'. You can clone the template to your Voiceflow account, by clicking here.

3. Connecting your Voiceflow Assistant to Streamline Connector

Step 1: Find Your API Key - Open your Voiceflow assistant project. Go to the "Integrations" tab, and copy the API key.
Step 2: Connect the Assistant - On the Shopify app homepage, click "Connect Assistant" and enter the copied API key along with the assistant's name. The Chatbot name you give here does not have to match your Voiceflow's Assistant.

4. Sending your product data

Keep your AI assistant up-to-date with the latest product changes. Our webhooks monitor Shopify updates and automatically

synchronize them with your assistant at your preferred interval. Once your assistant is connected, easily add active products by

clicking the three dots on your assistant card and selecting 'Manage Data' > 'Create' > 'Send Products' then completing the

required fields. This will update your assistant's knowledge base with a JSON table, enhancing its performance.

‍

Important Note:

Retain the default selections for searchable and metadata fields to ensure accurate recommendations.

5. Connecting your orders

We've developed a dynamic database of your store's orders to minimize unnecessary API calls to Shopify's Order API whenever

a user inquires, 'Where is my order?' Our system provides an endpoint that retrieves orders associated with a user's email. For

added security, we've included a unique shop ID to ensure that users can only access orders from your store and not from others

linked to their email.

To set this up, follow these steps:

Click the three dots on your assistant card and select 'Create' > 'Send Orders'.
Copy the endpoint provided.
In VoiceFlow, navigate to your Assistant, then:
- Click on 'Content' in the left sidebar.
- Go to 'Functions' and select 'Retrieve Streamline Order'.
Replace the text on line 17 with the copied endpoint.

‍

Copy the Endpoint URL string.

‍

Navigate to your Assistant in Voiceflow and then click on Functions and then Retrieve Streamline Order.

‍

Replace paste your endpoint in here with your copied endpoint.

‍

Example:

6. Replace 'BRAND' on the Assistant home

You can do this by clicking on Designer > Home and clicking on the text you want to replace.

Click the block with the text you want to replace

‍

Enter your brand name.

7. Replace sample best sellers with your own

You can update the product recommendations by following these steps:

Navigate to Designer: Click on the "Designer" tab in your interface.
Go to Product Recommendations: Find the "Product Recommendations" section.
Replace Products: Replace each product manually by selecting them one by one from the existing list.

‍

Add as many cards as you wish.

8. Tweak/Replace System prompts to suit your brand and product offering

See industry-specific prompt examples here.

Access the Recommendation Prompt
- Open the "Recommendation prompt"
Select Optimize Question
- Click on the first tab labeled "Optimize Question," which will open a screen on the right side.
Scroll to Set Variables
- Scroll down to the "Set Variables" section and expand the "Prompt" field.
Tweak the Prompt
- In the "Prompt" field, you can customize the content to match your brand's products and offerings.
- Important: Do not remove {userQuestion} variable, and keep the same format to avoid breaking the AI agent.
Adjust System Prompts
- Scroll down to the "System" box.
- Replace any references to "Melinda's Hot Sauce" with prompts that align with your brand or industry.
- For example, if you're in the beauty industry, use language like, "You are a beauty expert, knowledgeable about
- the beauty industry."
Repeat the above process for{OptimizedQuestion}
- Under Instructions, change update the prompt text to your products and offerings
- Scroll down to tweak the "System" box's content to change the role of the AI Agent to align with your brand and industry.

9. Add to your store

Once you are done and the Assistant is tested, you can hit Publish, navigate to the integration tab and copy the script you will find

on Web Chat. Go to your theme > edit code > theme.liquid and paste the code before </body>.

10. Rigorously test before launching

Before releasing your Voiceflow assistant to all your customers, it's important to conduct a small-scale test with a

representative group. This ensures that the assistant performs as expected and that customer interactions align

with your brand's goals.

After successful testing, you can confidently launch your Voiceflow assistant to a broader audience, knowing that it will deliver

a valuable and engaging experience to your customers.

‍

For more information on testing, read our 'How to test your AI Agent before going live' guide.