LiveAgent

The LiveAgent modules allow you to list, retrieve, create, add, remove, and delete the customers, conversations, and groups from your LiveAgent account.

Getting Started with LiveAgent

Prerequisites

Note

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

To connect your LiveAgent account to Make you need to obtain the API Key and Domain URL from your LiveAgent account and insert it in the Create a connection dialog in the Make module.

1. Log in to your LiveAgent account.

2. Click Settings.

61f272776941c.png

2. Click System>API>Settings for API V1.

61f2727906174.png

3. Copy the API Key and Your API URL to your clipboard.

61f2727a811e2.png

4. Log in to your Make account, add a module from the LiveAgent app into an Make scenario.

5. Click Add next to the Connection field.

61f2727c08612.gif

6. In the Connection name field, enter a name for the connection.

7. In the API Key and Domain URL field, enter the details copied in step 3 and click Continue.

The connection has been established.

Watch Customers

Triggers when a new customer has been created.

Connection

Establish a connection to your LiveAgent account.

Limit

Set the maximum number of results Make should return during one execution cycle. The default value is 10.

List Customers

Responds with a list of available customers.

Connection

Establish a connection to your LiveAgent account.

Email

Select or map the email address to list the customer that matches the specified email address.

Phone

Enter (map) the phone number to list the customers that match the specified number.

Facebook

Enter (map) the Facebook User ID to list the customers that match the specified ID.

Twitter

Enter (map) the Twitter ID to list the customers that match the specified ID.

First Name

Enter (map) the first name of the customers to list the customers that match the specified name.

Last Name

Enter (map) the last name of the customers to list the customers that match the specified name.

Company ID

Enter (map) the Company ID to list the customers that match the specified ID.

Date Created From

Enter (map) a date to list the customers that are created on or after the specified time. See the list of supported date and time formats.

Date Created To

Enter (map) a date to list the customers that are created on or before the specified time. See the list of supported date and time formats.

Limit

Set the maximum number of results Make should return during one execution cycle. The default value is 10.

Get a Customer

Retrieves info about customers.

Connection

Establish a connection to your LiveAgent account.

Contact ID

Select or map the Contact ID whose details you want to retrieve.

Create a Customer

Creates a new customer.

Connection

Establish a connection to your LiveAgent account.

Email

Enter (map) the email address of the customer.

Phone

Enter (map) the phone number of the customer.

Name

Enter (map) the customer's name in the first name last name format.

Gender

Select or map the gender of the customer:

  • Male

  • Female

Role

Select the role of the customer:

  • Visitor

  • Registered Visitor

Password

Enter (map) the password for the customer.

Note

Set password for registered visitor only. If empty, a standard email notification is sent to the visitor with a request to set his password.

Unique Fields

Enter (map) the additional unique field values:

Code

Enter (map) the code for the customer. For example, email.

Value

Enter (map) the value for the customer. For example, the email address of the customer.

Custom Fields

Enter (map) the custom field values:

Code

Enter (map) the code for the customer. For example, address.

Value

Enter (map) the value for the customer. For example, customer's address.

Customer Note

Enter (map) additional information about the customer.

Send Registration Email

Select whether you want to send the registration email to the customer.

Add a Customer to a Group

Adds a customer to the specific group.

Connection

Establish a connection to your LiveAgent account.

Customer ID

Select or map the Customer ID you want to add to the group.

Group Name

Select or map the group name to which you want to add the customer.

Remove a Customer from a Group

Removes a customer from a specific group.

Connection

Establish a connection to your LiveAgent account.

Customer ID

Select or map the Customer ID you want to remove from the group.

Group Name

Select or map the group name from which you want to remove the customer.

List Conversations

Responds with conversations.

Connection

Establish a connection to your LiveAgent account.

Department ID

Select or map the Department ID whose conversations you want to list.

Owner ID

Enter (map) the Owner ID to list the conversations that match the specified ID. This could be the Email ID of the customer.

Agent

Enter (map) the agent identifier to list the conversations that match the specified identifier. This could be the USer ID or Email ID.

Status

Enter (map) the status to list the conversations that match the specified status. It can contain one specific status or multiple statuses separated by a comma.

Date From

Enter (map) a date to list the conversations that were created on or after the specified date. See the list of supported date and time formats.

Date To

Enter (map) a date to list the conversations that were created on or before the specified date. See the list of supported date and time formats.

Date Changed

Enter (map) a date to list the conversation that was changed on the specified date. See the list of supported date and time formats.

Subject

Enter (map) the subject of the conversation you want to list.

Channel Type

Enter (map) the channel type to list the conversations. It can contain one specific channel type or multiple channel types separated by a comma.

Limit

Set the maximum number of results Make should return during one execution cycle. The default value is 10.

Get a Conversation

Responds with a certain conversation.

Connection

Establish a connection to your LiveAgent account.

Conversation ID

Select or map the Conversation ID whose details you want to retrieve.

Create a Conversation

Creates a new conversation.

Connection

Establish a connection to your LiveAgent account.

Message

Enter (map) the message text of the conversation.

Department ID

Select or map the Department ID to which the conversation is associated.

User Identifier

Enter (map) the user identifier to create a new conversation. This can be the User ID or Email of an existing agent or the Email of an existing visitor.

Message Subject

Enter (map) the subject of the message.

Recipient

Select or map the recipient's email address. If the User Identifier is a visitor, the recipient must be a LiveAgent mail account. If the User Identifier is an agent, the recipient must be a visitor.

Recipient Name

Enter (map) the recipient name in Firstname Lastname format.

CC

Enter (map) the recipient's email addresses you want to add in the CC field of the email.

Status

Select the status of the conversation:

  • Answered

  • Calling

  • Chatting

  • Deleted

  • Spam

  • Init

  • Open

  • Resolved

  • New

  • Postponed

Mail Message ID

Enter (map) the Mail Message ID of the conversation. If specified, all reply emails which will have given mail message-id in the in-reply-to header will be assigned to this conversation.

Do Not Send Mail

Select whether to send an email to the customer.

Use Template

Select whether to use the department mail template and add a message into the mail template text.

Is HTML Message

Select whether to format this message in HTML format.

Custom Fields

Enter (map) the custom field values:

Code

Enter (map) the code for the customer

Value

Enter (map) the value for the customer

Note

These values should be predefined from the admin panel.

Attachments

Add the attachment File IDs. For example, 3a1d0a821ea3a63594ba826efad0a379.

Delete a Conversation

Deletes a conversation.

Connection

Establish a connection to your LiveAgent account.

Conversation ID

Select or map the Conversation ID you want to delete.

Note

Enter (map) the additional information for deleting the conversation.

User ID

Select or map the User ID whose conversations you want to delete.

List Groups

Gets all groups.

Connection

Establish a connection to your LiveAgent account.

Limit

Set the maximum number of results Make should return during one execution cycle. The default value is 10.

Get a Group

Responds with a group.

Connection

Establish a connection to your LiveAgent account.

Group ID

Select or map the Group ID whose details you want to retrieve.

Create a Group

Creates a new customer group.

Connection

Establish a connection to your LiveAgent account.

Name

Enter (map) a name for the customer's group.

Color

Enter (map) the color for the group name.

Background Color

Enter (map) the background color for the group.

Update a Group

Updates a certain group.

Connection

Establish a connection to your LiveAgent account.

Group ID

Select or map the Group ID whose details you want to update.

Name

Enter (map) a new name for the customer's group.

Color

Enter (map) the color for the group name.

Background Color

Enter (map) the background color for the group.

Delete a Group

Deletes a customer group.

Connection

Establish a connection to your LiveAgent account.

Group ID

Select or map the Group ID you want to delete.

Make an API Call

Performs an arbitrary authorized API Call.

Connection

Establish a connection to your LiveAgent account.

URL

Enter a path relative to https://<domain>.labdesk.com/api/ For example: /customers.

Note

For the list of available endpoints, refer to the LiveAgent API Documentation.

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.

POST to create a new entry.

PUT to update/replace an existing entry.

PATCH to make a partial entry update.

DELETE to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Customers

The following API call returns all the customers from your LiveAgent account:

URL: /customers

Method: GET

61f2727e68f2c.png

Matches of the search can be found in the module's Output under Bundle > Body > response > customers. In our example, 5 customers were returned:

61f2727f7ec95.png