Floup documentation

Go to Floup

Introduction

Floup enables you to create advanced human like chat bots on your site that can answer customer queries and complete actions on behalf of customers after a request from a customer (eg. chaning a customers password).

Creating a new chat bot

At the top center of the Floup dashboard (Go to the Floup dashboard), click the drop down and choose to create a new chat bot. All of your existing chat bots will appear in this drop downs list. Fill in all of the required information about your new chat bot and then click 'Create'. Next, follow the integration instructions below in order to add the chat bot to your website.

Integration

It is easy to get Floup set up answering customer queries and this can be done without you or anyone having to write any code. However, to enable Floup to complete actions on behalf of customers upon customer requests, some additional configuration will be required and you will need to have an API (Application Programming Interface) - this requires code to be written.

Adding the Floup chat widget to your website:

Either:

• If you are currently using Google Tag Manager on your website, add the Floup tag and then publish your changes in Google Tag Manager (recommended).
• Add the Floup script tag to every page on your website where you want the Floup chat widget to be displayed.

In the top center of the Floup dashboard (Go to the Floup dashboard), click the drop down and choose the chatbot which you wish to add to your website. Next, go to the 'add this chatbot on your website section' and follow the integration instructions there.

Actions

Your chatbot can complete actions like resetting customers passwords upon their request. For this to work, follow the set up instructions below:

• Create an API (Application Programming Interface). You will need a developer in order to this. Your API should take in values provided by Floup in the request headers and then use them to complete the desired action.
• Next, create an action in the Floup dashboard for your chatbot. Slect the dropdown at the top centre of this page and slect your chatbot. Scroll down to the 'Chatbot actions' section and choose to create a new chatbot action.
• Give your new action an action ID. This is not public to customers that use your chatbot. Its only purpose is to allow you to identify different actions easily.
• Fill in all of the information about your new action. Refer to the table below for help regarding what each part is asking you for.

Section	Part of information	Notes	Example
Action settings	Message (from customer) to invoke this action	Provide an example message that the customer could send in order to invoke this action. Note: Customers will not be restricted to only having to type this example message as messages that are similar by meaning will also be accepted.	Customer: "I want to change my password"
Values to collect in order to complete this action	Value ID and message to request value	The value ID identifies the value. The value will be obtained through the AI customer support chatbot sending the message that you have provided in the 'message to request value' field. The customers reply to this message will be set to the value. You can have multiple values, but make sure that each value has a unique value ID. When Floup does a HTTP request to your API, a header value will be set for each value with the header name being equal to the value ID (with all spaces and punctuation omitted) and the header value being equal to the value that has been collected (eg. the customers email).	Value ID: account email Message to request value: AI: "What is your account email?"
HTTP request to API settings	URL	The full URL link to your API. Include either http:// or https:// at the start of the URL.	https://example.com/api
HTTP request to API settings	Method	The HTTP method that should be used in the HTTP request to your API.	One of the following: GET, POST, PUT, PATCH, DELETE

When a customer sends a message to invoke this action, Floup will collect all of the required values from the customer and then send them all to your API. The response from your API will determine the message sent by the chatbot to a customer after the action is complete. Take a look at some example responses which your API could send in order to work with Floup.

• Plain text (string) : "Your password has been changed"
• JSON object: {floupMessage: "Your password has been changed"}

If you use the JSON object response type, you can add other keys to the JSON object which can allow your API to work with and without Floup. Floup will ignore all other keys in your JSON object.