Skip to main content
LiveChat logo
  • Category: customer support
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 111
  • Triggers: 0
  • Slug: LIVECHAT
  • Version: 20261101_00

Tools

Slug: LIVECHAT_ACCEPT_GREETINGAccept an incoming LiveChat greeting for an existing customer and mark that greeting as seen in the customer’s live session. This changes greeting state.

Input Parameters

string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
Unique greeting instance ID from the incoming_greeting push.
integer
required
ID of the configured greeting to accept.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_APPROVE_AGENTApprove a licensed LiveChat agent so they can use the application. This non-public operation requires the private subscription.lc:rw grant and changes the agent’s approval state; do not retry it automatically.

Input Parameters

string
required
ID of the agent to approve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CANCEL_GREETINGCancel an incoming LiveChat invitation for an existing customer. This changes the greeting state in the customer’s live session.

Input Parameters

string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
Unique greeting instance ID from the incoming_greeting push.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CHECK_PRODUCT_LIMITS_FOR_PLANRead which current organization resources exceed a selected LiveChat plan’s limits. This action requires the private subscription.lc:rw grant, which cannot be configured for ordinary public OAuth clients.

Input Parameters

string ("starter" | "team" | "enterprise" | "enterpriseplus")
required
LiveChat plan whose resource limits should be checked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_AGENTCreate a normal-role licensed LiveChat user who must await approval. This safe baseline may consume a paid seat and send an irreversible account or approval email. Do not retry after an uncertain outcome. Use Create Privileged Agent only for approval bypass or an elevated role.

Input Parameters

string
required
Agent ID, normally the licensed user’s email address.
string
required
Agent display name.
array
Groups the new agent belongs to and their priority in each.
string
Agent mobile number.
string
Agent job title.
string ("accepting chats" | "not accepting chats")
Default status immediately after login.
array
Agent notifications to enable.
object
Working schedule for the new agent.
integer
Maximum number of concurrent chats assigned to the agent.
array
Summary emails to send to the agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_AUTO_ACCESSAdd an ordered LiveChat auto-access rule. The rule immediately changes which groups customers matching its conditions can access.

Input Parameters

object
required
Destination access for matching customers.
string
Existing rule ID before which to insert this rule; empty places it last.
object
required
Conditions to check; set at least one of url, domain, or geolocation.
string
Description of the auto-access rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_BOTCreate a LiveChat bot and return its write-once secret. Treat the secret as a credential and never log or replay it. The bot does not receive chats until its routing status is set; clean up only through a controlled lifecycle.

Input Parameters

string
required
Bot display name.
string
Custom value used to categorize or identify the bot.
string
Bot avatar URL.
array
Groups the bot belongs to and its priority in each.
string
Bot job title.
object
Working schedule for the bot.
integer
Maximum number of incoming chats that can be routed to the bot.
string
Client ID that owns the bot. Required with a Personal Access Token; the Bearer Token’s client ID takes precedence when OAuth is used.
string ("first" | "normal" | "last" | "supervisor")
Routing priority used for groups without an override.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_BOT_TEMPLATECreate a bot template for an application client ID and return its write-once secret. Treat the secret as a credential. This affects only the template and future installations; it does not create bots on existing installations.

Input Parameters

string
required
Bot template display name.
string
Bot template avatar URL.
string
Job title for installed bots.
integer
Maximum number of incoming chats routed to each installed bot.
string
required
Client ID that will own the template; it must belong to the organization.
string ("first" | "normal" | "last" | "supervisor")
Default group routing priority for installed bots.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_BOT_TEMPLATE_ACROSS_INSTALLATIONSCreate a LiveChat bot template and also create a bot from it on every license where the app is already installed. This is a cross-license bulk creation and returns a sensitive write-once template secret.

Input Parameters

string
required
Bot template display name.
string
Bot template avatar URL.
string
Job title for installed bots.
integer
Maximum number of incoming chats routed to each installed bot.
string
required
Client ID that will own the template; it must belong to the organization.
string ("first" | "normal" | "last" | "supervisor")
Default group routing priority for installed bots.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_CANNED_RESPONSECreate a group-owned LiveChat canned response. LiveChat sanitizes its text, and is_private controls whether other users can see it.

Input Parameters

array
required
Tags assigned to the canned response.
string
required
Canned-response text. LiveChat sanitizes it and rejects content that becomes empty after sanitization.
integer
required
ID of the group that owns the canned response.
boolean
Whether the canned response is private instead of public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_GREETINGCreate a LiveChat greeting with trigger rules and optional rich content. An active greeting can immediately appear to matching visitors; use active=false while safely preparing it.

Input Parameters

string
required
Greeting name.
string ("normal" | "announcement")
required
Normal or one-time announcement greeting type.
string
required
Group ID assigned to the greeting, or null.
array
required
Rules defining when the greeting is triggered.
boolean
required
Whether the greeting becomes active immediately after creation.
object
Additional provider-defined greeting key/value properties.
string
RFC 3339 date-time when the greeting becomes active.
string
RFC 3339 date-time when the greeting stops being active.
object
Optional structured rich-message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_GROUPCreate a LiveChat routing group with its initial language and agent-priority map.

Input Parameters

string
required
Group name, up to 180 characters.
string
Language code for the group.
object
required
Agent priorities as a map from agent ID to first, normal, last, or supervisor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_PRIVILEGED_AGENTCreate a licensed LiveChat agent while explicitly bypassing approval and/or assigning an elevated administrator or viceowner role. This may consume a paid seat, send an irreversible account or approval email, and uses stronger or private grants than Create Agent. Do not retry after an uncertain outcome.

Input Parameters

string
required
Agent ID, normally the licensed user’s email address.
string
required
Agent display name.
string ("viceowner" | "administrator" | "normal")
Agent role; administrator and viceowner require the elevated-role grant.
array
Groups the new agent belongs to and their priority in each.
string
Agent mobile number.
string
Agent job title.
string ("accepting chats" | "not accepting chats")
Default status immediately after login.
array
Agent notifications to enable.
object
Working schedule for the new agent.
integer
Maximum number of concurrent chats assigned to the agent.
boolean
Whether the new agent must await approval. False bypasses approval and requires both account-write and private subscription grants.
array
Summary emails to send to the agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_CREATE_TAGCreate a LiveChat tag and optionally assign it to groups. Tag-name duplicate matching is case insensitive.

Input Parameters

string
required
Tag name; matching an existing name during creation is case insensitive.
array
Group IDs to assign the tag to; may be empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DEACTIVATE_CHATDeactivate a LiveChat chat by closing its currently open thread. This takes effect immediately and prevents further messages to that thread. Use only for an explicitly selected chat; do not repeat after an uncertain outcome.

Input Parameters

string
required
ID of the chat to deactivate.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_AGENTPermanently delete a licensed LiveChat agent. This irreversible operation removes the user from the license; verify the exact agent ID and do not retry automatically.

Input Parameters

string
required
ID of the licensed agent to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_AUTO_ACCESSPermanently delete an auto-access rule. This immediately changes customer access routing and should only target a confirmed rule ID.

Input Parameters

string
required
ID of the auto-access rule to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_BOTPermanently delete a LiveChat bot. This irreversible operation can remove a bot from live routing; use an explicit verified bot ID and do not retry automatically.

Input Parameters

string
required
ID of the bot to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_BOT_TEMPLATEPermanently delete only a bot template. Bots already installed from the template on existing licenses are not deleted.

Input Parameters

string
required
ID of the bot template to permanently delete.
string
required
Client ID that owns the template; it must belong to the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_BOT_TEMPLATE_AND_INSTALLED_BOTSPermanently delete a LiveChat bot template and every bot installed from it across all licenses. This cross-license bulk deletion can disrupt live routing and must not be retried automatically.

Input Parameters

string
required
ID of the bot template to permanently delete.
string
required
Client ID that owns the template; it must belong to the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_CANNED_RESPONSEPermanently delete one canned response by ID, removing it from agent use. Use only a confirmed disposable or intentionally retired response.

Input Parameters

integer
required
ID of the canned response to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_CHAT_PROPERTIESPermanently delete selected registered property values from a live customer chat. Property data may contain PII; this action does not retry.

Input Parameters

string
required
ID of the live chat whose properties will be deleted.
string
required
Non-secret client ID from the server-side LiveChat app Authorization block.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
object
required
Property names to delete, grouped by registered namespace. Deleted values cannot be recovered by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_EVENTDelete one event from a specified LiveChat chat and thread. This is an irreversible customer-visible action: Customer Chat API responses hide the event, while Agent Chat can retain it as deleted or visible to elevated roles. Use only captured IDs from a disposable lifecycle and do not repeat after an uncertain outcome.

Input Parameters

string
required
ID of the chat containing the event.
string
required
ID of the event to delete.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
ID of the thread containing the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_EVENT_PROPERTIESPermanently delete selected registered property values from a live customer-chat event. Property data may contain PII; this action does not retry.

Input Parameters

string
required
ID of the chat containing the event.
string
required
ID of the event whose properties will be deleted.
string
required
Non-secret client ID from the server-side LiveChat app Authorization block.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
ID of the thread containing the event.
object
required
Property names to delete, grouped by registered namespace. Deleted values cannot be recovered by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_GREETINGPermanently delete a greeting, immediately stopping it from appearing to new matching visitors. Use only a confirmed disposable or retired greeting ID.

Input Parameters

integer
required
ID of the greeting to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_GROUPPermanently delete one LiveChat group by ID.

Input Parameters

integer
required
Group ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_GROUP_PROPERTIESDelete selected custom property values from one LiveChat group without unregistering their definitions.

Input Parameters

integer
required
Group ID whose property values to clear.
object
required
Property names to clear, keyed by namespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_LICENSE_PROPERTIESDelete selected license-level custom property values without unregistering their definitions.

Input Parameters

object
required
Property names to delete, grouped by namespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_TAGPermanently delete the exact case-sensitive LiveChat tag, removing it from workflows that rely on that tag. Use a confirmed disposable or retired name.

Input Parameters

string
required
Exact case-sensitive name of the tag to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DELETE_THREAD_PROPERTIESPermanently delete selected registered property values from a live customer-chat thread. Property data may contain PII; this action does not retry.

Input Parameters

string
required
ID of the chat containing the thread.
string
required
Non-secret client ID from the server-side LiveChat app Authorization block.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
ID of the thread whose properties will be deleted.
object
required
Property names to delete, grouped by registered namespace. Deleted values cannot be recovered by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_DISABLE_LICENSE_WEBHOOKSDisable all webhooks across the connected LiveChat license. Warning: this causes a license-wide webhook outage that persists through application reinstall.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_ENABLE_LICENSE_WEBHOOKSEnable webhooks across the connected LiveChat license after they were explicitly disabled. Warning: this changes license-wide integration state and should not be treated as a guaranteed safe rollback without owner approval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_EVALUATE_GOALSTrigger LiveChat goal evaluation for an offline customer. Achieved goals can record conversions and trigger configured integrations from the supplied session fields, group, and page URL.

Input Parameters

integer
required
Group ID whose goals should be evaluated.
string
required
Page URL on which LiveChat should check goal achievement.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
array
required
Custom object-enclosed key-value pairs used to evaluate goals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_AGENTReturn one LiveChat agent by ID, including any explicitly requested optional fields.

Input Parameters

array
Additional agent fields to include in the response.
string
required
Agent ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_BOTReturn one LiveChat bot by ID with explicitly requested optional fields.

Input Parameters

string
required
ID of the bot to retrieve.
array
Additional bot fields to include in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_CUSTOMERReturn the customer profile for an explicit existing LiveChat entity through the server-side customer authorization bridge.

Input Parameters

string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_CUSTOMER_CHATReturn one existing customer’s LiveChat chat and either its latest thread or a specified thread.

Input Parameters

string
required
Chat ID to retrieve.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
Specific thread ID to return; omit to return the latest thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_CUSTOMER_CONFIGURATIONReturn versioned forms, buttons, integrations, and readable properties for a LiveChat customer group.

Input Parameters

string
required
Configuration version returned as config_version by Get Dynamic Customer Configuration.
integer
required
Group ID returned by Get Dynamic Customer Configuration.
string
required
Unique identifier of the LiveChat organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_CUSTOMER_FORMReturn the enabled pre-chat or post-chat form for one LiveChat group.

Input Parameters

integer
required
Group ID whose enabled customer form to return.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string ("prechat" | "postchat")
required
Form type to retrieve: prechat or postchat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_CUSTOMER_LOCALIZATIONReturn versioned customer-facing localization phrases for a LiveChat group and language through LiveChat’s public Customer Chat endpoint.

Input Parameters

string
required
Localization version returned as localization_version by Get Dynamic Customer Configuration.
integer
required
Group ID returned by Get Dynamic Customer Configuration.
string
required
Language code returned by dynamic configuration or explicitly requested.
string
required
Unique identifier of the LiveChat organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_DYNAMIC_CUSTOMER_CONFIGURATIONReturn current customer-facing widget availability and the version identifiers needed for detailed configuration and localization reads.

Input Parameters

string
Page URL used to evaluate trusted-domain configuration.
boolean
Treat this dynamic-configuration lookup as a test request.
integer
Group whose dynamic configuration to return; omit for the default group.
integer
LiveChat license ID used to select the dynamic configuration. Provide license_id or organization_id; at least one selector is required.
string
Channel type whose configuration to evaluate.
string
LiveChat organization ID used to select the dynamic configuration. Provide organization_id or license_id; at least one selector is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_GREETINGGet one LiveChat greeting, including its rules and rich-message structure.

Input Parameters

integer
required
Greeting ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_GROUPReturn one LiveChat group by ID, including any explicitly requested optional fields.

Input Parameters

array
Additional group fields to include.
integer
required
Group ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_LICENSE_WEBHOOKS_STATEReturn whether webhook delivery is enabled for the connected LiveChat license.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_PREDICTED_AGENTReturn whether a new chat for an existing customer is predicted to queue and the agent predicted to receive it, when available.

Input Parameters

string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_PRODUCT_SOURCEReturn the source parameters supplied when the Text product was activated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_GET_URL_PREVIEWReturn LiveChat-hosted preview image URLs for a public webpage without changing chat state.

Input Parameters

string
required
Public HTTP or HTTPS webpage URL to inspect.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_ISSUE_BOT_TOKENIssue a sensitive, non-revocable bot bearer token valid for 24 hours. The request secret and returned token must never be logged, stored in fixtures, or replayed; this action performs one request with no automatic loop.

Input Parameters

string
required
ID of the bot for which to issue a token.
string
required
OAuth application client ID that owns the bot.
string
required
Sensitive bot secret. It is sent only to LiveChat and must never be logged.
string
required
Organization ID that owns the bot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_AGENTSList LiveChat agents, optionally filtering by group membership or suspension state.

Input Parameters

array
Additional agent fields to include for each result.
array
Return only agents belonging to these group IDs.
boolean
Return only agents whose suspended state matches this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_ALL_BOTSList every bot in the LiveChat license, including bots not owned by the connected app. This is a privileged license-wide inventory read.

Input Parameters

array
Additional bot fields to include for each result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_ALL_PRIVATE_CANNED_RESPONSESReturn one page of canned responses, including private responses across the requested LiveChat groups. This privileged read can expose private records beyond those normally accessible to the caller; use the continuation cursor to fetch later pages.

Input Parameters

integer
Number of results on this page.
string
Continuation page ID returned as next_page_id by a previous call.
array
Group IDs to filter by; omitted uses groups accessible to the caller.
boolean
Whether to include the caller’s private canned responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_AUTO_ACCESSESList all LiveChat auto-access rules in their evaluation order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_BOTSList only bots owned by the connected LiveChat app. Use List All Bots for the privileged license-wide inventory.

Input Parameters

array
Additional bot fields to include for each result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_BOT_TEMPLATESList bot templates owned by a specified OAuth application client ID.

Input Parameters

string
required
Client ID of an application owned by the connected organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CANNED_RESPONSESReturn one page of canned responses accessible to the caller and a next_page_id for explicit continuation. This action never reads every private response or fetches subsequent pages automatically.

Input Parameters

integer
Number of results on this page.
string
Continuation page ID returned as next_page_id by a previous call.
array
Group IDs to filter by; omitted uses groups accessible to the caller.
boolean
Whether to include the caller’s private canned responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CHANNELSList summaries of communication channels used by the connected Text product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CUSTOMER_BANSList all active customer bans. Results can contain sensitive IP addresses and customer identifiers and should not be persisted unnecessarily.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CUSTOMER_CHATSList one existing customer’s chat summaries through LiveChat’s server-side customer authorization bridge, returning one page at a time.

Input Parameters

integer
Maximum chat summaries on the first page; omit for the default of 10.
string
Opaque next_cursor returned by a previous call. The documented limit and sort_order controls may also be provided.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string ("asc" | "desc")
First-page order by latest-thread creation time; omit for descending order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CUSTOMER_CHAT_THREADSList threads from one existing customer’s chat through LiveChat’s server-side customer authorization bridge, returning one page at a time.

Input Parameters

integer
Maximum threads on the first page; omit for the default of 3.
string
Opaque next_cursor returned by a previous call. It cannot be combined with min_events_count; limit and sort_order remain available.
string
required
Chat ID whose threads to list.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string ("asc" | "desc")
First-page order; omit for newest threads first.
integer
Minimum total events to include across the latest threads. Cannot be combined with limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CUSTOMER_GROUP_PROPERTIESRead the custom property values a customer may access for one LiveChat group. Property values may contain customer data. Warning: live probes of this documented public endpoint currently return HTTP 405 or unsupported action; call it only to check whether provider support has been restored.

Input Parameters

integer
required
ID of the group whose customer-visible properties to return.
string
Exact property name to retrieve.
string
Exact property namespace to retrieve.
string
required
LiveChat organization ID whose customer-visible properties to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CUSTOMER_GROUP_STATUSESReturn chat availability statuses for selected LiveChat groups or all groups visible to an existing customer.

Input Parameters

string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
array
Specific group IDs whose statuses to return. Provide exactly one selection: group_ids or all_groups=true, but not both.
boolean
Set true to return all visible groups. Provide exactly one selection: all_groups=true or group_ids, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_CUSTOMER_LICENSE_PROPERTIESRead the license property values visible to a LiveChat customer. Property values may contain customer data. Warning: live probes of this documented public endpoint currently return HTTP 405 or unsupported action; call it only to check whether provider support has been restored.

Input Parameters

string
Exact property name to retrieve.
string
Exact property namespace to retrieve.
string
required
LiveChat organization ID whose customer-visible properties to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_GREETINGSList a bounded page of LiveChat greetings, optionally filtered by group. Use the returned native next_page_id in a later call when present.

Input Parameters

integer
Greetings per page; cannot be combined with page_id.
array
Group IDs to filter by; cannot be combined with page_id.
string
Native page ID; cannot be combined with groups or limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_GROUP_PROPERTIESRead group-level property values for selected LiveChat groups or a property namespace.

Input Parameters

array
required
Group IDs to read. Pass an empty list to return properties from all groups.
string
Optional property namespace to return.
string
Return only property names beginning with this prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_GROUPSList all LiveChat groups, optionally requesting additional fields for each group.

Input Parameters

array
Additional group fields to include for each result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_LICENSE_PROPERTIESRead license-level property values, optionally narrowed to a namespace and property-name prefix.

Input Parameters

string
Property namespace to return.
string
Return only property names beginning with this prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_PROPERTY_DEFINITIONSList private and public LiveChat property definitions owned by a specified OAuth application client ID.

Input Parameters

string
required
Client ID of the application whose property definitions to list; the client ID must belong to the connected organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_TAGSList LiveChat tags, optionally filtering by nested group IDs.

Input Parameters

object
Optional tag-list filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_WEBHOOK_NAMESList webhook actions supported by LiveChat Configuration API version 3.6, including their accepted filters and additional payload data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_LIST_WEBHOOKSList webhooks registered for a specified OAuth application client ID.

Input Parameters

string
required
Client ID of the application whose registered webhooks to list; the client ID must belong to the connected organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_MARK_EVENTS_AS_SEENAdvance an existing customer’s seen state in a LiveChat chat through an RFC 3339 timestamp. This emits a read-receipt state change for the chat.

Input Parameters

string
required
Chat whose events should be marked seen.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
RFC 3339 timestamp through which events should be marked seen, creating the customer’s read receipt up to this point.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_PUBLISH_PROPERTYPublish a private property for access by tokens belonging to any Client ID. Warning: publication is irreversible; a published property cannot be unpublished or unregistered.

Input Parameters

string
required
Name of the private property to publish.
array
required
Access levels granted to Client IDs other than owner_client_id.
string
required
Client ID that owns the property; it must belong to the connected organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_REACTIVATE_EMAILReactivate a bounced external email address for one LiveChat agent. Warning: this changes external email delivery state and may resume messages to that address.

Input Parameters

string
required
Agent ID whose bounced external email address should be reactivated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_REGISTER_PROPERTYRegister one private custom property definition for a LiveChat OAuth application.

Input Parameters

string
required
Property name to register.
object
Allowed inclusive integer range. Valid only when property_type is int and cannot be combined with domain.
object
required
Access rules keyed by property location; at least one location and one user type per location are required.
array
Allowed property values. Every value must match property_type; cannot be combined with range.
string
Human-readable property description.
string
Default value matching property_type and any domain or range constraint. Allowed only for license or group properties.
string ("int" | "string" | "bool" | "tokenized_string")
required
Value type enforced for the property. Use tokenized_string for searchable long text, not keywords.
string
required
Client ID of the application that will own the property; it must belong to the connected organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_REGISTER_WEBHOOKRegister one LiveChat webhook endpoint for an OAuth application and action.

Input Parameters

string
required
Destination URL for webhook deliveries, up to 500 characters.
string ("incoming_chat" | "chat_deactivated" | "chat_access_updated" | "chat_transferred" | "user_added_to_chat" | "user_removed_from_chat" | "incoming_event" | "event_deleted" | "event_updated" | "incoming_rich_message_postback" | "chat_properties_updated" | "chat_properties_deleted" | "thread_properties_updated" | "thread_properties_deleted" | "event_properties_updated" | "event_properties_deleted" | "thread_tagged" | "thread_untagged" | "routing_status_set" | "customer_session_fields_updated" | "events_marked_as_seen" | "group_created" | "group_updated" | "group_deleted" | "agent_created" | "agent_updated" | "agent_deleted" | "agent_suspended" | "agent_unsuspended" | "agent_approved" | "bot_created" | "bot_updated" | "bot_deleted" | "auto_accesses_updated" | "tag_created" | "tag_deleted" | "tag_updated" | "thread_summary_set")
required
Webhook action to register. Use List Webhook Names to confirm its currently advertised filters.
object
Action-specific filters advertised for the selected action by List Webhook Names.
string
required
Secret LiveChat sends with webhook deliveries for origin verification; it is sent only to LiveChat and never returned by this action.
string
Human-readable webhook description.
string ("bot" | "license")
required
Whether to register a bot or license webhook. Sent to LiveChat as type.
array
Additional payload data advertised for the selected action by List Webhook Names.
string
required
Client ID of the application that will own the webhook; it must belong to the connected organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_REQUEST_AGENT_UNSUSPENSIONRequest unsuspension for the connected suspended agent. LiveChat sends external emails to the license owners and vice owners; do not retry this notification operation automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_REQUEST_EMAIL_VERIFICATIONSend a verification email to an existing LiveChat customer. After confirmation, LiveChat sends the verified email to the supplied HTTPS callback exactly once and expects HTTP 200; failed callbacks are not retried.

Input Parameters

string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
HTTPS endpoint LiveChat calls with POST after the customer confirms their email. HTTPS is required because the payload contains verified email PII. Return HTTP 200 because LiveChat does not retry this callback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_REQUEST_WELCOME_MESSAGERequest an asynchronous welcome message for an existing logged-in customer. This creates greeting session state, emits incoming_welcome_message later, and can affect AI or agent routing; the response reports the predicted route.

Input Parameters

string
Welcome message ID, when selecting a specific welcome message.
integer
Group ID used to choose the welcome message and predicted routing.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string ("message_and_questions" | "questions_only")
Whether an AI agent may provide the welcome message and questions or questions only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_RESET_BOT_SECRETIrreversibly rotate a bot secret and return the sensitive replacement. The old credential stops working; update dependents immediately and never log, persist, replay, or automatically retry this operation.

Input Parameters

string
required
ID of the bot whose secret will be rotated.
string
Client ID that owns the bot. Required with a Personal Access Token; the Bearer Token’s client ID takes precedence when OAuth is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_RESET_BOT_TEMPLATE_AND_INSTALLED_BOT_SECRETSIrreversibly rotate a LiveChat bot template secret and set the replacement on every installed bot based on it across all licenses. This bulk credential rotation invalidates prior secrets; never log, replay, or automatically retry it.

Input Parameters

string
required
ID of the bot template whose secret will be rotated.
string
required
Client ID that owns the template; it must belong to the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_RESET_BOT_TEMPLATE_SECRETIrreversibly rotate only a bot template secret and return the sensitive replacement. Existing installed bot secrets are unchanged; never log, replay, or automatically retry this action.

Input Parameters

string
required
ID of the bot template whose secret will be rotated.
string
required
Client ID that owns the template; it must belong to the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_RESUME_CHATResume an archived LiveChat chat for an existing customer entity. This is non-idempotent: a successful call creates a new thread and can create initial events, change access or continuous mode, and mark events seen. Do not repeat a call after an uncertain outcome.

Input Parameters

object
required
Archived chat and optional new thread data.
boolean
Whether the newly created thread is active. Defaults to true.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
boolean
New continuous-mode setting; omit to leave the setting unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_SEND_EVENTSend one event into a real LiveChat chat for an existing customer. This is non-idempotent: a successful call creates and delivers the event and marks chat events seen for the customer. Do not repeat after an uncertain outcome, because duplicate messages or interactions can be delivered.

Input Parameters

object
required
Documented Customer Chat event object. Preserve the fields required by the selected event type; the form event type is not supported by this action.
string
required
ID of the chat to receive the event.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
boolean
For an inactive chat, attach the event to its last thread. If false, sending to an inactive chat fails. Ignored for active chats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_SEND_FILE_EVENTUpload one non-executable file of at most 10,000,000 bytes and irreversibly deliver it as a file event in an existing LiveChat chat. Delivery also marks chat events seen for the customer. If delivery fails after upload, the temporary uploaded file can remain without an event; do not retry after an uncertain outcome.

Input Parameters

object
required
Non-executable file to upload and deliver. Maximum size is 10,000,000 bytes.
string
required
ID of the chat to receive the file event.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
boolean
For an inactive chat, attach the file event to its last thread. If false, delivery to an inactive chat fails. Ignored for active chats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_SEND_GREETING_BUTTON_CLICKEDRecord that an existing customer clicked a specific button in an incoming LiveChat greeting. This writes interaction state for the live session.

Input Parameters

string
required
ID of the greeting button the customer clicked.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
Unique greeting instance ID from the incoming_greeting push.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_SEND_RICH_MESSAGE_POSTBACKSend a button postback for an existing rich-message event. This is non-idempotent and changes the live interaction state; for an active thread it can emit an incoming-rich-message-postback notification. Do not repeat a call after an uncertain outcome.

Input Parameters

string
required
ID of the chat containing the rich message.
string
required
ID of the rich-message event.
object
required
Button postback payload to send.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
ID of the thread containing the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_SEND_SNEAK_PEEKSend transient typed content into a real LiveChat chat before the customer submits it as a message. Agents may see the supplied text immediately. This is non-idempotent interaction activity; do not repeat after an uncertain outcome.

Input Parameters

string
required
ID of the chat to receive the sneak peek.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
Transient text to expose to the live chat before it is sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_SET_CUSTOMER_SESSION_FIELDSReplace an existing LiveChat customer’s ordered session fields. This mutates customer session/profile data and the values may contain PII.

Input Parameters

string
required
Client ID from the Authorization block of the server-side LiveChat app. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
array
required
Up to 100 ordered custom object-enclosed key/value pairs. This replaces the supplied session fields and values may contain customer PII.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_START_CHATStart a new LiveChat chat for an existing customer entity. This is non-idempotent: every successful call can create a real chat, thread, and initial events, and it also marks existing chat events seen for the customer. Do not repeat a call after an uncertain outcome.

Input Parameters

object
Optional initial chat data.
boolean
Whether to create an active thread. Defaults to true.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
boolean
Whether to start a continuous chat, which does not require an online group. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_SUSPEND_AGENTSuspend a licensed LiveChat agent. This non-public operation requires the private sessions—all:rw grant and can interrupt active sessions and live chat routing; do not retry it automatically.

Input Parameters

string
required
ID of the agent to suspend.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UNBAN_CUSTOMERLift a customer ban by IP address or customer ID. Warning: this restores the customer’s access to the connected LiveChat license.

Input Parameters

string
IP address to unban. Provide exactly one of ip and customer_id.
string
Unique customer identifier to unban. Provide exactly one of ip and customer_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UNREGISTER_PROPERTYPermanently remove one custom property definition owned by an OAuth application.

Input Parameters

string
required
Registered property name to remove.
string
required
Client ID of the application that owns the property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UNREGISTER_WEBHOOKPermanently remove one webhook registration owned by a LiveChat OAuth application.

Input Parameters

string
required
Webhook registration ID to remove.
string
required
Client ID of the application that owns the webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UNSUSPEND_AGENTUnsuspend a licensed LiveChat agent. This non-public operation requires the private subscription.lc:rw grant and restores the agent’s ability to participate in live routing; do not retry it automatically.

Input Parameters

string
required
ID of the agent to unsuspend.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_AGENTUpdate a licensed LiveChat agent. Role, group, login-status, chat-capacity, notification, and schedule changes can immediately alter permissions or live routing; verify the target and intended fields before calling.

Input Parameters

string
required
ID of the agent to update.
string ("viceowner" | "administrator" | "normal")
Replacement agent role.
array
Replacement groups for the agent and their priority in each.
string
Replacement mobile number.
string
Replacement job title.
string ("accepting chats" | "not accepting chats")
Replacement default status immediately after login.
array
Replacement set of enabled notifications.
object
Replacement work scheduler.
integer
Replacement maximum number of concurrent chats.
array
Replacement summary-email subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_AUTO_ACCESSUpdate or reorder an auto-access rule. Changes immediately affect customer access routing, so use a confirmed disposable or intended rule ID.

Input Parameters

string
required
ID of the auto-access rule to modify.
object
Replacement destination access.
string
Move this rule before the specified rule ID; an empty string moves it last. Omit this field to preserve ordering.
object
Replacement conditions; set at least one of url, domain, or geolocation.
string
Replacement description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_BOTUpdate a LiveChat bot. Group, priority, schedule, and chat-capacity changes can immediately alter live routing; verify the bot and intended fields before calling.

Input Parameters

string
required
ID of the bot to update.
string
Replacement bot display name.
string
Replacement custom bot category or identifier.
string
Replacement bot avatar URL.
array
Replacement groups and routing priorities for the bot.
string
Replacement bot job title.
object
Replacement working schedule for the bot.
integer
Replacement maximum number of incoming chats routed to the bot.
string ("first" | "normal" | "last" | "supervisor")
Replacement default group routing priority.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_BOT_TEMPLATEFully replace a LiveChat bot template for future installations. Existing installed bots are not changed. Omitted optional replacement fields are reset or cleared to provider defaults.

Input Parameters

string
required
ID of the bot template to update.
string
Replacement template display name. Omitting this optional replacement field resets or clears it to the provider default.
string
Replacement template avatar URL. Omitting this optional replacement field resets or clears it to the provider default.
string
Replacement job title for installed bots. Omitting this optional replacement field resets or clears it to the provider default.
integer
Replacement maximum incoming chats for bots based on the template. Omitting this optional replacement field resets or clears it to the provider default.
string
required
Client ID that owns the template; it must belong to the organization.
string ("first" | "normal" | "last" | "supervisor")
Replacement default routing priority for installed bots. Omitting this optional replacement field resets or clears it to the provider default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_CANNED_RESPONSEUpdate an existing canned response while preserving omitted fields. Changing its group or privacy setting changes who can access it.

Input Parameters

integer
required
ID of the canned response to update.
array
Replacement tag list.
string
Replacement text. LiveChat sanitizes it and rejects content that becomes empty after sanitization.
integer
Replacement owning group ID.
boolean
Whether the canned response should be private instead of public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_CHAT_PROPERTIESSet registered custom property values on a live customer chat. This mutates chat state and values may contain PII.

Input Parameters

string
required
ID of the live chat whose properties will be changed.
string
required
Non-secret client ID from the server-side LiveChat app Authorization block.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
object
required
Property values grouped by registered namespace. Values may contain customer PII.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_COMPANY_DETAILSUpdate license-level company details. Warning: this is an organization-wide change, and enrich=true may populate currently empty fields from the company domain.

Input Parameters

string
Company URL.
string
Company city.
string
Company phone number.
string
Company state.
boolean
Whether LiveChat should try to fill empty fields by searching for the company domain.
string
Company street address.
string
Company name.
string
Company country.
string
Company audience.
string
Company province.
string
Company postal code.
string
Company chat purpose.
string
Company size.
string
Invoice recipient name.
string
Invoice email address.
string
Company tax identification number (NIP).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_CUSTOMERPartially update an existing LiveChat customer profile. This writes PII and may change omnichannel identity matching; omitted fields remain unchanged.

Input Parameters

string
Customer name. This is PII.
string
Customer email address. This is PII.
string
Customer avatar URL.
object
Customer postal address. This is PII.
string
required
Client ID from the Authorization block of the server-side LiveChat app. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
object
Omnichannel identity links to change; changing these may affect identity matching.
string
Customer phone number in E.164 format. This is PII.
array
Ordered custom object-enclosed key/value pairs. Values may contain PII and replace the supplied customer session fields.
string
Unconfirmed email inferred from tracked activity. Supply null or an empty value to clear only this suggestion. This is PII.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_EVENT_PROPERTIESSet registered custom property values on a live customer-chat event. This mutates event state and values may contain PII.

Input Parameters

string
required
ID of the chat containing the event.
string
required
ID of the event whose properties will be changed.
string
required
Non-secret client ID from the server-side LiveChat app Authorization block.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
ID of the thread containing the event.
object
required
Property values grouped by registered namespace. Values may contain customer PII.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_GREETINGUpdate a greeting while preserving omitted fields. Rule, content, or active changes affect matching visitors immediately; deactivate before structural editing when appropriate.

Input Parameters

integer
required
ID of the greeting to update.
string
Replacement greeting name.
string ("normal" | "announcement")
Replacement greeting type.
array
Replacement trigger-rule list.
boolean
Whether the greeting should be active.
object
Replacement provider-defined greeting properties.
string
Replacement RFC 3339 activation date-time.
string
Replacement RFC 3339 deactivation date-time.
object
Replacement structured rich-message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_GROUPUpdate the name, language, or complete agent-priority map of an existing LiveChat group.

Input Parameters

string
Replacement group name, up to 180 characters.
integer
required
Group ID to update.
string
Replacement group language code.
object
Complete replacement map from agent IDs to routing priorities. Allowed priorities are first, normal, last, and supervisor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_GROUP_PROPERTIESSet one or more custom property values on a LiveChat group.

Input Parameters

integer
required
Group ID whose property values to set.
object
required
Group property values grouped by namespace and then property name. Each property must already be registered for group access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_INSTALLED_BOTS_FROM_TEMPLATEFully replace a LiveChat bot template and propagate the replacement to every bot installed from it across all licenses. Omitted optional replacement fields are reset or cleared to provider defaults. This bulk cross-license update can immediately change live bot routing behavior.

Input Parameters

string
required
ID of the bot template to update.
string
Replacement template display name. Omitting this optional replacement field resets or clears it to the provider default.
string
Replacement template avatar URL. Omitting this optional replacement field resets or clears it to the provider default.
string
Replacement job title for installed bots. Omitting this optional replacement field resets or clears it to the provider default.
integer
Replacement maximum incoming chats for bots based on the template. Omitting this optional replacement field resets or clears it to the provider default.
string
required
Client ID that owns the template; it must belong to the organization.
string ("first" | "normal" | "last" | "supervisor")
Replacement default routing priority for installed bots. Omitting this optional replacement field resets or clears it to the provider default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_LICENSE_PROPERTIESSet one or more license-level custom property values grouped by namespace.

Input Parameters

object
required
License property values grouped by namespace and then property name. Each property must already be registered for license access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_TAGUpdate a LiveChat tag identified by its exact case-sensitive name. When provided, group_ids replaces the tag’s group assignment.

Input Parameters

string
required
Exact case-sensitive name of the tag to update.
array
Complete replacement group assignment for the tag; may be empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPDATE_THREAD_PROPERTIESSet registered custom property values on a live customer-chat thread. This mutates thread state and values may contain PII.

Input Parameters

string
required
ID of the chat containing the thread.
string
required
Non-secret client ID from the server-side LiveChat app Authorization block.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.
string
required
ID of the thread whose properties will be changed.
object
required
Property values grouped by registered namespace. Values may contain customer PII.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LIVECHAT_UPLOAD_FILEUpload one non-executable file of at most 10,000,000 bytes for later use in a Customer Chat event. This creates a temporary provider-hosted file URL that expires after 24 hours unless used in send_event. Do not repeat after an uncertain outcome because each successful call uploads another file.

Input Parameters

object
required
File to upload as multipart/form-data. Maximum size is 10,000,000 bytes. LiveChat rejects executable files.
string
required
Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier.
string
required
Stable caller-chosen entity_id used for token exchange. If it does not exist for this OAuth app, LiveChat creates a new customer identity during token exchange; reuse the same entity_id to address the same customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not