Project

Profile

Help

Store Website Chat Logs from Userlike in Planio Help Desk » History » Sprint/Milestone 7

Jan Schulz-Hofen, 03/14/2017 12:19 PM

1 1 Jan Schulz-Hofen
# Store Website Chat Logs from Userlike in Planio Help Desk
2
3
Using [Userlike](https://www.userlike.com/) for chatting live with your website visitors is great and it's an awesome way to provide support or explain your product.
4
5
Normally, Userlike sends you an email after each chat session with a chat log, so you can keep it for future reference. We thought it would be great to store these chat logs in [Planio Help Desk](https://plan.io/customer-service-and-help-desk/) as issues instead, so you'll have everything neatly organized by contact and so you'll be able to see support issues from Planio side-by-side with Userlike chats.
6
7 3 Jan Schulz-Hofen
{{>toc}}
8
9 1 Jan Schulz-Hofen
Setting it up is really easy:
10
11
## Set up Planio Help Desk
12
13
If you haven't already, set up Planio Help Desk in one of your projects. We have an in-depth guide about [[Set_up_Your_Help_Desk_App|how to set up Planio Help Desk]], but if you really just want to get started quickly, just do the following:
14
15
1.  Navigate to your project
16
2.  Click on the **Apps** tab
17
3.  Find **Planio Help Desk**
18
4.  Click **Install**
19
20 2 Jan Schulz-Hofen
{{figure(Install Planio Help Desk)
21 1 Jan Schulz-Hofen
!Helpdesk_install_button@2x.png!
22 2 Jan Schulz-Hofen
}}
23
24
## Configure an API end point in Userlike
25
26
Next, we'll log in to Userlike. You'll need your Userlike username and password for this. Once logged in, we are going to:
27
28
1.  Find **Config** in the left hand menu
29
2.  Click on **Addons Settings**
30
3.  Find an entry called **API** in the table
31
4.  Click on its small **Edit** icon on the far right
32
33
{{figure(Configure an API end point in Userlike)
34
!userlike_main_menu@2x.png!
35 1 Jan Schulz-Hofen
}}
36 3 Jan Schulz-Hofen
37 6 Jan Schulz-Hofen
You'll be presented with a configuration form. We'll get to that in a minute.
38 3 Jan Schulz-Hofen
39 6 Jan Schulz-Hofen
Let's figure our your **Callback URL** first!
40 4 Jan Schulz-Hofen
41
## Constructing the Userlike Callback URL
42
43
This part can be a little technically. But don't worry – we'll get through this.
44
45
Generally speaking, the **Callback URL** needs to follow this format:
46
47
~~~
48 5 Jan Schulz-Hofen
https://acme.plan.io/projects/support/userlike_callback?key=abc123
49 4 Jan Schulz-Hofen
~~~
50
51
The URL needs to be adapted to fit your particular Planio account though, so let's take a closer look:
52 1 Jan Schulz-Hofen
53 5 Jan Schulz-Hofen
  - `https://acme.plan.io/projects/support` is the full URL to the designated project where you activated Planio Help Desk. You can copy it from your browser's address bar when you're on the **Overview** tab of your project. `acme.plan.io` is your Planio domain and `support` is the project's **Identifier**.
54
  - `/userlike_callback` instructs Planio that this call is coming from Userlike, it does not need to be changed
55
  - `?key=abc123` is a secret key for authentication purposes. In Planio, please navigate to *your avatar* -\> **Administration** -\> **Settings** -\> **Incoming emails** and find the key in the field labeled **Incoming email WS API key**. Now, replace `abc123` in your URL with your actual key.
56
57
That's it. Now, paste your URL in the corresponding field on Userlike and select one or two of the **Automatic Tickets** boxes:
58
59
  - Select **for Offline Messages** if you would like to receive messages in Planio when you're offline in Userlike Chat and a website visitor leaves a message.
60
  - Select **for Chats** if you would like to receive actual chat logs with your website visitors in Planio.
61
62 7 Jan Schulz-Hofen
Our recommendation is to select both checkboxes. Here's what it should look like:
63
64
{{figure(Userlike Callback API form)
65
!userlike_callback_form@2x.png!
66
}}
67 5 Jan Schulz-Hofen
68
Please *leave all other checkboxes unchecked* and finally, click on **Update settings**.