LiveChat
LiveChat is an online customer service software with live support, help desk software and web analytics capabilities.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Microsoft |
URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
Connector Metadata | |
---|---|
Publisher | Microsoft |
Website | https://www.livechat.com/ |
Privacy policy | https://www.livechat.com/legal/privacy-policy/ |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Username | string | The email address for this account | True |
API Key | securestring | The API Key for this account | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Create a new agent |
This operation is used to add a new agent to your LiveChat account. |
Create a new ticket |
This operation is used to add a new ticket to your LiveChat account. |
Get ticket |
This operation is used to fetch the details of a specific ticket in your LiveChat account. |
List agents |
This operation returns a list of all the agents in your LiveChat account. |
List tickets |
This operation returns a list of tickets in your LiveChat account. |
Remove an agent |
This operation is used to delete an agent from your LiveChat account. |
Update ticket |
This operation is used to update the details of an existing ticket in your LiveChat account. |
Create a new agent
This operation is used to add a new agent to your LiveChat account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Email
|
login | True | string | |
Name
|
name | True | string | |
Login status
|
login_status | string | ||
Title
|
job_title | string |
Defaults to: Support Agent. |
|
Permission
|
permission | string | ||
Password
|
password | string |
Minimum length 5. |
|
Max chat counts
|
max_chats_count | string |
Limit of the concurrent chats. |
Returns
- Body
- CreateAgent_Response
Create a new ticket
This operation is used to add a new ticket to your LiveChat account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Message
|
message | True | string | |
Requester's Email
|
True | string | ||
Requester's Name
|
name | string | ||
Subject
|
subject | string | ||
Assignee Id
|
id | string | ||
Source Type
|
type | string |
Pick a source |
|
Source URL
|
url | string |
If source type is chat-window. |
Returns
- Body
- TicketResponse
Get ticket
This operation is used to fetch the details of a specific ticket in your LiveChat account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
The id of the ticket |
Returns
- Body
- TicketResponse
List agents
This operation returns a list of all the agents in your LiveChat account.
Returns
List of all agents with their details.
- Items
- ListAgents_Response
List tickets
This operation returns a list of tickets in your LiveChat account.
Returns
- Items
- ListTicketsResponse
Remove an agent
This operation is used to delete an agent from your LiveChat account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Email
|
login | True | string |
The email of the agent. |
Returns
- Body
- DeleteAgent_Response
Update ticket
This operation is used to update the details of an existing ticket in your LiveChat account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
The id of the ticket |
Message
|
message | string | ||
Requester's Email
|
True | string | ||
Requester's Name
|
name | string | ||
Subject
|
subject | string | ||
Assignee Id
|
id | string |
Pick an assignee. |
|
Source Type
|
type | string |
Pick a source. |
|
Source URL
|
url | string |
If source type is chat-window. |
Returns
- Body
- TicketResponse
Triggers
When a chat ends |
This operation triggers when a chat ends. |
When a chat starts |
This operation triggers when new a chat starts. |
When a ticket is created |
This operation triggers when a new ticket is added. |
When a chat ends
When a chat starts
When a ticket is created
Definitions
WebhookChatResponse
Name | Path | Type | Description |
---|---|---|---|
agents
|
chat.agents | array of object |
agents |
Agent Email
|
chat.agents.login | string |
Email address of the agent. |
Agent Name
|
chat.agents.name | string |
Name of the agent. |
Ended Timestamp
|
chat.ended_timestamp | string |
yyyy-MM-ddTHH:mm:ss.fffZ |
events
|
chat.events | array of object |
Array of events. |
Event Text
|
chat.events.text | string |
Message associated with the event. |
Event Date-Time
|
chat.events.timestamp | string |
yyyy-MM-ddTHH:mm:ss.fffZ |
Event Type
|
chat.events.type | string |
Type of event. |
Event User Type
|
chat.events.user_type | string |
Type of user. |
groups
|
chat.groups | array of integer | |
Group Id
|
chat.id | string |
Unique identifier of the group. |
Message
|
chat.messages | array of object |
Array of messages. |
Agent Id
|
chat.messages.agent_id | string |
Unique id of the agent associated with the message. |
Author Name
|
chat.messages.author_name | string |
Name of the message's author.. |
Text
|
chat.messages.text | string |
Body of the message. |
Sent Date-Time
|
chat.messages.timestamp | string |
yyyy-MM-ddTHH:mm:ss.fffZ |
User Type
|
chat.messages.user_type | string |
Type of the user sending the message. |
Started Date-Time
|
chat.started_timestamp | string |
yyyy-MM-ddTHH:mm:ss.fffZ |
tags
|
chat.tags | array of string | |
URL
|
chat.url | string |
Url of the website where chat started. |
Event Id
|
event_unique_id | string |
Unique id of the event associated with the chat. |
Pre Chat Survey
|
pre_chat_survey | array of object |
Array of pre chat survey responses. |
Answer
|
pre_chat_survey.answer | string |
Survey answer. |
Survey Id
|
pre_chat_survey.id | string |
Pre chat survey id. |
Question
|
pre_chat_survey.label | string |
Survey question. |
Email
|
visitor.email | string |
Email address of the visitor. |
Id
|
visitor.id | string |
Unique id of the visitor. |
Language
|
visitor.language | string |
Language associated with the visitor's account. |
Name
|
visitor.name | string |
Name of the visitor. |
Page
|
visitor.page_current | string |
Webpage that the chat originated from. |
WebhookTicketResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
ticket.assignee.id | string |
Unique identifier of the user. |
Name
|
ticket.assignee.name | string |
Name of the assignee. |
events
|
ticket.events | array of object | |
Id
|
ticket.events.author.id | string |
Unique id of the user. |
Name
|
ticket.events.author.name | string |
Name of the author. |
Type
|
ticket.events.author.type | string |
Agent or client. |
Event Date-Time
|
ticket.events.date | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Is Private
|
ticket.events.is_private | boolean |
True if event is private. |
Message
|
ticket.events.message | string |
Description of the event. |
Type
|
ticket.events.source.type | string |
Chat-window, mail or lc2. |
URL
|
ticket.events.source.url | string |
Url of the website that the ticket was sent from. |
Event Type
|
ticket.events.type | string |
Type of event that generated the ticket. |
Group
|
ticket.groups | array of object |
Details of the associated group. |
Id
|
ticket.groups.id | integer |
Unique id of the group. |
Name
|
ticket.groups.name | string |
Name of the group. |
Ticket Id
|
ticket.id | string |
Unique id of the ticket. |
IP
|
ticket.requester.ip | string |
IP address of the requester. |
Email
|
ticket.requester.mail | string |
Email address of the requester. |
Name
|
ticket.requester.name | string |
Name of the requester. |
Id
|
ticket.source.id | string |
Unique id of the source. |
Type
|
ticket.source.type | string |
Lc2, mail, facebook, agent-app-manual or chat-window. |
URL
|
ticket.source.url | string |
Url of the website where ticket was created. |
Status
|
ticket.status | string |
Open, pending, solved or spam. |
Subject
|
ticket.subject | string |
Short description of the ticket. |
tags
|
ticket.tags | array of string |
ListTicketsResponse
Name | Path | Type | Description |
---|---|---|---|
Created Date-Time
|
date | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Ticket Id
|
id | string |
Unique identifier of the ticket. |
Modified Date-Time
|
modified | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
IP
|
requester.ip | string |
IP address of the requester. |
Email
|
requester.mail | string |
Email address of the requester. |
Name
|
requester.name | string |
Full name of the requester. |
Id
|
source.id | string |
Unique identifier of the source. |
Type
|
source.type | string |
From chat, mail or lc2. |
URL
|
source.url | string |
Webpage where the ticket was created. |
Status
|
status | string |
Open, pending, solved or spam. |
Subject
|
subject | string |
Description of the ticket source. |
TicketResponse
Name | Path | Type | Description |
---|---|---|---|
Id
|
currentGroup.id | integer |
Unique id of the group. |
Name
|
currentGroup.name | string |
Name of the group. |
Created Date-Time
|
date | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
events
|
events | array of object | |
Id
|
events.author.id | string |
Unique id of the user. |
Name
|
events.author.name | string |
Name of the author. |
Type
|
events.author.type | string |
Agent or client. |
Event Date-Time
|
events.date | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Is Private
|
events.is_private | boolean |
True if event is private. |
Message
|
events.message | string |
Description of the event. |
Type
|
events.source.type | string |
Chat-window, mail or lc2. |
URL
|
events.source.url | string |
Url of the website that the ticket was sent from. |
Event Type
|
events.type | string |
Type of event that generated the ticket. |
Group
|
groups | array of object |
Details of the associated group. |
Id
|
groups.id | integer |
Unique id of the group. |
Name
|
groups.name | string |
Name of the group. |
Ticket Id
|
id | string |
Unique id of the ticket. |
IP
|
requester.ip | string |
IP address of the requester. |
Email
|
requester.mail | string |
Email address of the requester. |
Name
|
requester.name | string |
Name of the requester. |
Id
|
source.id | string |
Unique id of the source. |
Type
|
source.type | string |
Lc2, mail, facebook, agent-app-manual or chat-window. |
URL
|
source.url | string |
Url of the website where ticket was created. |
Status
|
status | string |
Open, pending, solved or spam. |
Subject
|
subject | string |
Short description of the ticket. |
tags
|
tags | array of string |
ListAgents_Response
List of all agents with their details.
Name | Path | Type | Description |
---|---|---|---|
Avatar
|
avatar | string |
Path to the image on Amazon s3. |
Login Email
|
login | string |
The agent's email address. |
Name
|
name | string |
Agent's name. |
Permission
|
permission | string |
Owner, administrator or normal. |
CreateAgent_Response
Name | Path | Type | Description |
---|---|---|---|
Avatar
|
avatar | string |
Path to the image on Amazon s3. |
Groups Array
|
groups | array of object |
List of all groups the agent is a part of. |
Group Id
|
groups.id | integer |
Unique id of the group. |
Group Name
|
groups.name | string |
Name of the group. |
Job Title
|
job_title | string |
Support agent by default. |
Email
|
login | string |
The agent's email address. |
Login Status
|
login_status | string |
Accepting chats or not accepting chats. |
Max Chat Counts
|
max_chats_count | integer |
Limit of the concurrent chats. |
Name
|
name | string |
Agent's name. |
Permission
|
permission | string |
Owner, administrator or normal |
Status
|
status | string |
Accepting chats, not accepting chats or offline. |