Connectors Reference

LiveChat

LiveChat is an online customer service software with live support, help desk software and web analytics capabilities.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

DeleteHook (string hookId)

Delete hook

ListAgents ()

List agents

CreateAgent (CreateAgent_Request body)

Create a new agent

DeleteAgent (string login)

Remove an agent

ListTickets ()

List tickets

CreateTicket (Createticket_Request body)

Create a new ticket

UpdateTicket (string ticketId, Updateticket_Request body)

Update ticket

GetTicket (string ticketId)

Get ticket

WebhookResponse ([Optional]string logicAppsUri)

 

 

Triggers:

Name

Summary

WebhookTicketCreated ([internal]string event_type, [internal]string data_types[], [Optional]WebhookRequest body)

When a ticket is created

WebhookChatStarted ([internal]string event_type, [Optional]WebhookRequest body)

When a chat starts

WebhookChatEnded ([internal]string event_type, [Optional]WebhookRequest body)

When a chat ends

 

Objects:

Name

Summary

CreateAgent_Request

 

CreateAgent_Response

 

Createticket_Request

 

DeleteAgent_Response

 

ListAgentsResponseItem

 

ListTicketsResponseItem

 

TicketResponse

 

Updateticket_Request

 

WebhookRequest

 

 

Actions:

DeleteHook

Summary: Delete hook

Description: Delete a hook.

 

Syntax:

LiveChat.DeleteHook (string hookId)

 

Parameters:

Name

Type

Summary

Required

Related Action

hookId

string

 

 

True

 

Returns:

 

ListAgents

Summary: List agents

Description: This operation returns a list of all the agents in your LiveChat account.

 

Syntax:

LiveChat.ListAgents ()

 

Returns:

          Type:array of (ListAgentsResponseItem)

          Summary: Agents Array

          Description: List of all agents with their details.

 

CreateAgent

Summary: Create a new agent

Description: This operation is used to add a new agent to your LiveChat account.

 

Syntax:

LiveChat.CreateAgent (CreateAgent_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateAgent_Request

 

 

True

 

Returns:

          Type:CreateAgent_Response

 

DeleteAgent

Summary: Remove an agent

Description: This operation is used to delete an agent from your LiveChat account.

 

Syntax:

LiveChat.DeleteAgent (string login)

 

Parameters:

Name

Type

Summary

Required

Related Action

login

string

(Email)

 

True

 

Returns:

          Type:DeleteAgent_Response

 

ListTickets

Summary: List tickets

Description: This operation returns a list of tickets in your LiveChat account.

 

Syntax:

LiveChat.ListTickets ()

 

Returns:

          Type:array of (ListTicketsResponseItem)

 

CreateTicket

Summary: Create a new ticket

Description: This operation is used to add a new ticket to your LiveChat account.

 

Syntax:

LiveChat.CreateTicket (Createticket_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Createticket_Request

 

 

True

 

Returns:

          Type:TicketResponse

 

UpdateTicket

Summary: Update ticket

Description: This operation is used to update the details of an existing ticket in your LiveChat account.

 

Syntax:

LiveChat.UpdateTicket (string ticketId, Updateticket_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

 

True

body

Updateticket_Request

 

 

True

 

Returns:

          Type:TicketResponse

 

GetTicket

Summary: Get ticket

Description: This operation is used to fetch the details of a specific ticket in your LiveChat account.

 

Syntax:

LiveChat.GetTicket (string ticketId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

 

True

 

Returns:

          Type:TicketResponse

 

WebhookResponse

Summary:

Description:

 

Syntax:

LiveChat.WebhookResponse ([Optional]string logicAppsUri)

 

Parameters:

Name

Type

Summary

Required

Related Action

logicAppsUri

string

 

 

False

 

Returns:

 

Triggers:

Trigger WebhookTicketCreated

Summary: When a ticket is created

Description: This operation triggers when a new ticket is added.

 

Syntax:

LiveChat.WebhookTicketCreated ([internal]string event_type, [internal]string data_types[], [Optional]WebhookRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_type

string

 

 

True

data_types[]

string

 

 

True

body

WebhookRequest

 

 

False

 

Returns:

          Type:string

 

Trigger WebhookChatStarted

Summary: When a chat starts

Description: This operation triggers when new a chat starts.

 

Syntax:

LiveChat.WebhookChatStarted ([internal]string event_type, [Optional]WebhookRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_type

string

 

 

True

body

WebhookRequest

 

 

False

 

Returns:

          Type:string

 

Trigger WebhookChatEnded

Summary: When a chat ends

Description: This operation triggers when a chat ends.

 

Syntax:

LiveChat.WebhookChatEnded ([internal]string event_type, [Optional]WebhookRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_type

string

 

 

True

body

WebhookRequest

 

 

False

 

Returns:

          Type:string

 


 

CreateAgent_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

login

string

Email

 

name

string

Name

 

login_status

string

Login status

Values: [accepting chats, not accepting chats]

job_title

string

Title

Defaults to: Support Agent.

permission

string

Permission

Values: [administrator, normal]

password

string

Password

Minimum length 5.

max_chats_count

string

Max chat counts

Limit of the concurrent chats.


 

CreateAgent_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

avatar

string

Avatar

Path to the image on Amazon s3.

groups

array of (GroupsItem)

Groups Array

List of all groups the agent is a part of.

job_title

string

Job Title

Support agent by default.

license_id

integer(int32)

License Id

license_id

login

string

Email

The agent's email address.

login_status

string

Login Status

Accepting chats or not accepting chats.

max_chats_count

integer(int32)

Max Chat Counts

Limit of the concurrent chats.

name

string

Name

Agent's name.

permission

string

Permission

Owner, administrator or normal

status

string

Status

Accepting chats, not accepting chats or offline.

 

GroupsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Group Id

Unique id of the group.

name

string

Group Name

Name of the group.

 


 

Createticket_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

Message

 

requester

Requester

 

 

subject

string

Subject

 

assignee

Assignee

 

 

source

Source

 

 

 

Requester

Summary:

Description:

 

          Properties:

Name

Type

Summary

mail

string

Requester's Email

 

name

string

Requester's Name

 

 

Assignee

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Assignee Id

 

 

Source

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

Source Type

Pick a source  Values: [chat-window, mail, lc2]

url

string

Source URL

If source type is chat-window.

 


 

DeleteAgent_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

string

Result

 


 

ListAgentsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

avatar

string

Avatar

Path to the image on Amazon s3.

login

string

Login Email

The agent's email address.

name

string

Name

Agent's name.

permission

string

Permission

Owner, administrator or normal.


 

ListTicketsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

date

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

id

string

Ticket Id

Unique identifier of the ticket.

modified

string(date-time)

Modified Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

requester

Requester

Requester

requester

source

Source

Source

Details of the ticket source.

status

string

Status

Open, pending, solved or spam.

subject

string

Subject

Description of the ticket source.

 

Requester

Summary: Requester

Description: requester

 

          Properties:

Name

Type

Summary

ip

string

IP

IP address of the requester.

mail

string

Email

Email address of the requester.

name

string

Name

Full name of the requester.

 

Source

Summary: Source

Description: Details of the ticket source.

 

          Properties:

Name

Type

Summary

id

string

Id

Unique identifier of the source.

type

string

Type

From chat, mail or lc2.

url

string

URL

Webpage where the ticket was created.

 


 

TicketResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

currentGroup

CurrentGroup

Group

currentGroup

date

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

events

array of (EventsItem)

 

 

groups

array of (GroupsItem)

Group

Details of the associated group.

id

string

Ticket Id

Unique id of the ticket.

requester

Requester

Requester

Details of the requester.

source

Source

Source

 

status

string

Status

Open, pending, solved or spam.

subject

string

Subject

Short description of the ticket.

tags

array of (string)

 

 

 

CurrentGroup

Summary: Group

Description: currentGroup

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

Unique id of the group.

name

string

Name

Name of the group.

 

EventsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

author

Author

Author

 

date

string(date-time)

Event Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

is_private

boolean

Is Private

True if event is private.

message

string

Message

Description of the event.

source

Source

Source

Ticket source description.

type

string

Event Type

Type of event that generated the ticket.

 

Author

Summary: Author

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique id of the user.

name

string

Name

Name of the author.

type

string

Type

Agent or client.

 

Source

Summary: Source

Description: Ticket source description.

 

          Properties:

Name

Type

Summary

type

string

Type

Chat-window, mail or lc2.

url

string

URL

Url of the website that the ticket was sent from.

 

GroupsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

Unique id of the group.

name

string

Name

Name of the group.

 

Requester

Summary: Requester

Description: Details of the requester.

 

          Properties:

Name

Type

Summary

ip

string

IP

IP address of the requester.

mail

string

Email

Email address of the requester.

name

string

Name

Name of the requester.

 

Source

Summary: Source

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique id of the source.

type

string

Type

Lc2, mail, facebook, agent-app-manual or chat-window.

url

string

URL

Url of the website where ticket was created.

 


 

Updateticket_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

Message

 

requester

Requester

 

 

subject

string

Subject

 

assignee

Assignee

 

 

source

Source

 

 

 

Requester

Summary:

Description:

 

          Properties:

Name

Type

Summary

mail

string

Requester's Email

 

name

string

Requester's Name

 

 

Assignee

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Assignee Id

Pick an assignee.

 

Source

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

Source Type

Pick a source.  Values: [chat-window, mail, lc2]

url

string

Source URL

If source type is chat-window.

 


 

WebhookRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

url

string

url

url