--- canonical_url: "https://docs.composio.dev/toolkits/livechat" markdown_url: "https://docs.composio.dev/toolkits/livechat.md" product: "platform" version: null last_updated: null --- # LiveChat Manage LiveChat agents, groups, bots, webhooks, properties, and customer conversations through server-side OAuth. - **Category:** customer support - **Auth:** OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 111 - **Triggers:** 0 - **Slug:** `LIVECHAT` - **Version:** 00000000_00 ## Tools ### Accept Greeting **Slug:** `LIVECHAT_ACCEPT_GREETING` Accept 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `unique_id` | string | Yes | Unique greeting instance ID from the incoming_greeting push. | | `greeting_id` | integer | Yes | ID of the configured greeting to accept. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Approve Agent **Slug:** `LIVECHAT_APPROVE_AGENT` Approve 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the agent to approve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Greeting **Slug:** `LIVECHAT_CANCEL_GREETING` Cancel an incoming LiveChat invitation for an existing customer. This changes the greeting state in the customer's live session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `unique_id` | string | Yes | Unique greeting instance ID from the incoming_greeting push. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Product Limits for Plan **Slug:** `LIVECHAT_CHECK_PRODUCT_LIMITS_FOR_PLAN` Read 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `plan` | string ("starter" | "team" | "enterprise" | "enterpriseplus") | Yes | LiveChat plan whose resource limits should be checked. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Agent **Slug:** `LIVECHAT_CREATE_AGENT` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Agent ID, normally the licensed user's email address. | | `name` | string | Yes | Agent display name. | | `groups` | array | No | Groups the new agent belongs to and their priority in each. | | `mobile` | string | No | Agent mobile number. | | `job_title` | string | No | Agent job title. | | `login_status` | string ("accepting chats" | "not accepting chats") | No | Default status immediately after login. | | `notifications` | array | No | Agent notifications to enable. | | `work_scheduler` | object | No | Working schedule for the new agent. | | `max_chats_count` | integer | No | Maximum number of concurrent chats assigned to the agent. | | `email_subscriptions` | array | No | Summary emails to send to the agent. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Auto Access **Slug:** `LIVECHAT_CREATE_AUTO_ACCESS` Add an ordered LiveChat auto-access rule. The rule immediately changes which groups customers matching its conditions can access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `access` | object | Yes | Destination access for matching customers. | | `next_id` | string | No | Existing rule ID before which to insert this rule; empty places it last. | | `conditions` | object | Yes | Conditions to check; set at least one of url, domain, or geolocation. | | `description` | string | No | Description of the auto-access rule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Bot **Slug:** `LIVECHAT_CREATE_BOT` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Bot display name. | | `type` | string | No | Custom value used to categorize or identify the bot. | | `avatar` | string | No | Bot avatar URL. | | `groups` | array | No | Groups the bot belongs to and its priority in each. | | `job_title` | string | No | Bot job title. | | `work_scheduler` | object | No | Working schedule for the bot. | | `max_chats_count` | integer | No | Maximum number of incoming chats that can be routed to the bot. | | `owner_client_id` | string | No | Client ID that owns the bot. Required with a Personal Access Token; the Bearer Token's client ID takes precedence when OAuth is used. | | `default_group_priority` | string ("first" | "normal" | "last" | "supervisor") | No | Routing priority used for groups without an override. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Bot Template **Slug:** `LIVECHAT_CREATE_BOT_TEMPLATE` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Bot template display name. | | `avatar` | string | No | Bot template avatar URL. | | `job_title` | string | No | Job title for installed bots. | | `max_chats_count` | integer | No | Maximum number of incoming chats routed to each installed bot. | | `owner_client_id` | string | Yes | Client ID that will own the template; it must belong to the organization. | | `default_group_priority` | string ("first" | "normal" | "last" | "supervisor") | No | Default group routing priority for installed bots. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Bot Template Across Installations **Slug:** `LIVECHAT_CREATE_BOT_TEMPLATE_ACROSS_INSTALLATIONS` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Bot template display name. | | `avatar` | string | No | Bot template avatar URL. | | `job_title` | string | No | Job title for installed bots. | | `max_chats_count` | integer | No | Maximum number of incoming chats routed to each installed bot. | | `owner_client_id` | string | Yes | Client ID that will own the template; it must belong to the organization. | | `default_group_priority` | string ("first" | "normal" | "last" | "supervisor") | No | Default group routing priority for installed bots. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Canned Response **Slug:** `LIVECHAT_CREATE_CANNED_RESPONSE` Create a group-owned LiveChat canned response. LiveChat sanitizes its text, and is_private controls whether other users can see it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | Yes | Tags assigned to the canned response. | | `text` | string | Yes | Canned-response text. LiveChat sanitizes it and rejects content that becomes empty after sanitization. | | `group_id` | integer | Yes | ID of the group that owns the canned response. | | `is_private` | boolean | No | Whether the canned response is private instead of public. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Greeting **Slug:** `LIVECHAT_CREATE_GREETING` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Greeting name. | | `type` | string ("normal" | "announcement") | Yes | Normal or one-time announcement greeting type. | | `group` | string | Yes | Group ID assigned to the greeting, or null. | | `rules` | array | Yes | Rules defining when the greeting is triggered. | | `active` | boolean | Yes | Whether the greeting becomes active immediately after creation. | | `properties` | object | No | Additional provider-defined greeting key/value properties. | | `active_from` | string | No | RFC 3339 date-time when the greeting becomes active. | | `active_until` | string | No | RFC 3339 date-time when the greeting stops being active. | | `rich_message` | object | No | Optional structured rich-message content. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Group **Slug:** `LIVECHAT_CREATE_GROUP` Create a LiveChat routing group with its initial language and agent-priority map. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Group name, up to 180 characters. | | `language_code` | string | No | Language code for the group. | | `agent_priorities` | object | Yes | Agent priorities as a map from agent ID to first, normal, last, or supervisor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Privileged Agent **Slug:** `LIVECHAT_CREATE_PRIVILEGED_AGENT` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Agent ID, normally the licensed user's email address. | | `name` | string | Yes | Agent display name. | | `role` | string ("viceowner" | "administrator" | "normal") | No | Agent role; administrator and viceowner require the elevated-role grant. | | `groups` | array | No | Groups the new agent belongs to and their priority in each. | | `mobile` | string | No | Agent mobile number. | | `job_title` | string | No | Agent job title. | | `login_status` | string ("accepting chats" | "not accepting chats") | No | Default status immediately after login. | | `notifications` | array | No | Agent notifications to enable. | | `work_scheduler` | object | No | Working schedule for the new agent. | | `max_chats_count` | integer | No | Maximum number of concurrent chats assigned to the agent. | | `awaiting_approval` | boolean | No | Whether the new agent must await approval. False bypasses approval and requires both account-write and private subscription grants. | | `email_subscriptions` | array | No | Summary emails to send to the agent. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Tag **Slug:** `LIVECHAT_CREATE_TAG` Create a LiveChat tag and optionally assign it to groups. Tag-name duplicate matching is case insensitive. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Tag name; matching an existing name during creation is case insensitive. | | `group_ids` | array | No | Group IDs to assign the tag to; may be empty. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Deactivate Chat **Slug:** `LIVECHAT_DEACTIVATE_CHAT` Deactivate 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the chat to deactivate. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Agent **Slug:** `LIVECHAT_DELETE_AGENT` Permanently 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the licensed agent to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Auto Access **Slug:** `LIVECHAT_DELETE_AUTO_ACCESS` Permanently delete an auto-access rule. This immediately changes customer access routing and should only target a confirmed rule ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the auto-access rule to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Bot **Slug:** `LIVECHAT_DELETE_BOT` Permanently 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Bot Template **Slug:** `LIVECHAT_DELETE_BOT_TEMPLATE` Permanently delete only a bot template. Bots already installed from the template on existing licenses are not deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot template to permanently delete. | | `owner_client_id` | string | Yes | Client ID that owns the template; it must belong to the organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Bot Template And Installed Bots **Slug:** `LIVECHAT_DELETE_BOT_TEMPLATE_AND_INSTALLED_BOTS` Permanently 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot template to permanently delete. | | `owner_client_id` | string | Yes | Client ID that owns the template; it must belong to the organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Canned Response **Slug:** `LIVECHAT_DELETE_CANNED_RESPONSE` Permanently delete one canned response by ID, removing it from agent use. Use only a confirmed disposable or intentionally retired response. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | ID of the canned response to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Chat Properties **Slug:** `LIVECHAT_DELETE_CHAT_PROPERTIES` Permanently delete selected registered property values from a live customer chat. Property data may contain PII; this action does not retry. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the live chat whose properties will be deleted. | | `client_id` | string | Yes | Non-secret client ID from the server-side LiveChat app Authorization block. | | `entity_id` | string | Yes | 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. | | `properties` | object | Yes | Property names to delete, grouped by registered namespace. Deleted values cannot be recovered by this action. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Event **Slug:** `LIVECHAT_DELETE_EVENT` Delete 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | ID of the chat containing the event. | | `event_id` | string | Yes | ID of the event to delete. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `thread_id` | string | Yes | ID of the thread containing the event. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Event Properties **Slug:** `LIVECHAT_DELETE_EVENT_PROPERTIES` Permanently delete selected registered property values from a live customer-chat event. Property data may contain PII; this action does not retry. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | ID of the chat containing the event. | | `event_id` | string | Yes | ID of the event whose properties will be deleted. | | `client_id` | string | Yes | Non-secret client ID from the server-side LiveChat app Authorization block. | | `entity_id` | string | Yes | 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. | | `thread_id` | string | Yes | ID of the thread containing the event. | | `properties` | object | Yes | Property names to delete, grouped by registered namespace. Deleted values cannot be recovered by this action. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Greeting **Slug:** `LIVECHAT_DELETE_GREETING` Permanently delete a greeting, immediately stopping it from appearing to new matching visitors. Use only a confirmed disposable or retired greeting ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | ID of the greeting to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Group **Slug:** `LIVECHAT_DELETE_GROUP` Permanently delete one LiveChat group by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | Group ID to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Group Properties **Slug:** `LIVECHAT_DELETE_GROUP_PROPERTIES` Delete selected custom property values from one LiveChat group without unregistering their definitions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | Group ID whose property values to clear. | | `properties` | object | Yes | Property names to clear, keyed by namespace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete License Properties **Slug:** `LIVECHAT_DELETE_LICENSE_PROPERTIES` Delete selected license-level custom property values without unregistering their definitions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `properties` | object | Yes | Property names to delete, grouped by namespace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Tag **Slug:** `LIVECHAT_DELETE_TAG` Permanently 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Exact case-sensitive name of the tag to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Thread Properties **Slug:** `LIVECHAT_DELETE_THREAD_PROPERTIES` Permanently delete selected registered property values from a live customer-chat thread. Property data may contain PII; this action does not retry. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | ID of the chat containing the thread. | | `client_id` | string | Yes | Non-secret client ID from the server-side LiveChat app Authorization block. | | `entity_id` | string | Yes | 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. | | `thread_id` | string | Yes | ID of the thread whose properties will be deleted. | | `properties` | object | Yes | Property names to delete, grouped by registered namespace. Deleted values cannot be recovered by this action. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Disable License Webhooks **Slug:** `LIVECHAT_DISABLE_LICENSE_WEBHOOKS` Disable all webhooks across the connected LiveChat license. Warning: this causes a license-wide webhook outage that persists through application reinstall. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enable License Webhooks **Slug:** `LIVECHAT_ENABLE_LICENSE_WEBHOOKS` Enable 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate Goals **Slug:** `LIVECHAT_EVALUATE_GOALS` Trigger 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | Group ID whose goals should be evaluated. | | `page_url` | string | Yes | Page URL on which LiveChat should check goal achievement. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `session_fields` | array | Yes | Custom object-enclosed key-value pairs used to evaluate goals. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Agent **Slug:** `LIVECHAT_GET_AGENT` Return one LiveChat agent by ID, including any explicitly requested optional fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | array | No | Additional agent fields to include in the response. | | `agent_id` | string | Yes | Agent ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bot **Slug:** `LIVECHAT_GET_BOT` Return one LiveChat bot by ID with explicitly requested optional fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot to retrieve. | | `fields` | array | No | Additional bot fields to include in the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer **Slug:** `LIVECHAT_GET_CUSTOMER` Return the customer profile for an explicit existing LiveChat entity through the server-side customer authorization bridge. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer Chat **Slug:** `LIVECHAT_GET_CUSTOMER_CHAT` Return one existing customer's LiveChat chat and either its latest thread or a specified thread. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | Chat ID to retrieve. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `thread_id` | string | No | Specific thread ID to return; omit to return the latest thread. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer Configuration **Slug:** `LIVECHAT_GET_CUSTOMER_CONFIGURATION` Return versioned forms, buttons, integrations, and readable properties for a LiveChat customer group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `version` | string | Yes | Configuration version returned as config_version by Get Dynamic Customer Configuration. | | `group_id` | integer | Yes | Group ID returned by Get Dynamic Customer Configuration. | | `organization_id` | string | Yes | Unique identifier of the LiveChat organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer Form **Slug:** `LIVECHAT_GET_CUSTOMER_FORM` Return the enabled pre-chat or post-chat form for one LiveChat group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | Group ID whose enabled customer form to return. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `form_type` | string ("prechat" | "postchat") | Yes | Form type to retrieve: prechat or postchat. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer Localization **Slug:** `LIVECHAT_GET_CUSTOMER_LOCALIZATION` Return versioned customer-facing localization phrases for a LiveChat group and language through LiveChat's public Customer Chat endpoint. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `version` | string | Yes | Localization version returned as localization_version by Get Dynamic Customer Configuration. | | `group_id` | integer | Yes | Group ID returned by Get Dynamic Customer Configuration. | | `language` | string | Yes | Language code returned by dynamic configuration or explicitly requested. | | `organization_id` | string | Yes | Unique identifier of the LiveChat organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dynamic Customer Configuration **Slug:** `LIVECHAT_GET_DYNAMIC_CUSTOMER_CONFIGURATION` Return current customer-facing widget availability and the version identifiers needed for detailed configuration and localization reads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | Page URL used to evaluate trusted-domain configuration. | | `test` | boolean | No | Treat this dynamic-configuration lookup as a test request. | | `group_id` | integer | No | Group whose dynamic configuration to return; omit for the default group. | | `license_id` | integer | No | LiveChat license ID used to select the dynamic configuration. Provide license_id or organization_id; at least one selector is required. | | `channel_type` | string | No | Channel type whose configuration to evaluate. | | `organization_id` | string | No | LiveChat organization ID used to select the dynamic configuration. Provide organization_id or license_id; at least one selector is required. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Greeting **Slug:** `LIVECHAT_GET_GREETING` Get one LiveChat greeting, including its rules and rich-message structure. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Greeting ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Group **Slug:** `LIVECHAT_GET_GROUP` Return one LiveChat group by ID, including any explicitly requested optional fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | array | No | Additional group fields to include. | | `group_id` | integer | Yes | Group ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get License Webhooks State **Slug:** `LIVECHAT_GET_LICENSE_WEBHOOKS_STATE` Return whether webhook delivery is enabled for the connected LiveChat license. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Predicted Agent **Slug:** `LIVECHAT_GET_PREDICTED_AGENT` Return whether a new chat for an existing customer is predicted to queue and the agent predicted to receive it, when available. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Product Source **Slug:** `LIVECHAT_GET_PRODUCT_SOURCE` Return the source parameters supplied when the Text product was activated. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get URL Preview **Slug:** `LIVECHAT_GET_URL_PREVIEW` Return LiveChat-hosted preview image URLs for a public webpage without changing chat state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Public HTTP or HTTPS webpage URL to inspect. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Issue Bot Token **Slug:** `LIVECHAT_ISSUE_BOT_TOKEN` Issue 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `bot_id` | string | Yes | ID of the bot for which to issue a token. | | `client_id` | string | Yes | OAuth application client ID that owns the bot. | | `bot_secret` | string | Yes | Sensitive bot secret. It is sent only to LiveChat and must never be logged. | | `organization_id` | string | Yes | Organization ID that owns the bot. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Agents **Slug:** `LIVECHAT_LIST_AGENTS` List LiveChat agents, optionally filtering by group membership or suspension state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | array | No | Additional agent fields to include for each result. | | `group_ids` | array | No | Return only agents belonging to these group IDs. | | `suspended` | boolean | No | Return only agents whose suspended state matches this value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List All Bots **Slug:** `LIVECHAT_LIST_ALL_BOTS` List every bot in the LiveChat license, including bots not owned by the connected app. This is a privileged license-wide inventory read. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | array | No | Additional bot fields to include for each result. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List All Private Canned Responses **Slug:** `LIVECHAT_LIST_ALL_PRIVATE_CANNED_RESPONSES` Return one page including every private canned response across the requested LiveChat groups. This privileged read exposes private records beyond those normally accessible to the caller and never fetches later pages automatically. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of results on this page. | | `page_id` | string | No | Continuation page ID returned as next_page_id by a previous call. | | `group_ids` | array | No | Group IDs to filter by; omitted uses groups accessible to the caller. | | `include_private` | boolean | No | Whether to include the caller's private canned responses. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Auto Accesses **Slug:** `LIVECHAT_LIST_AUTO_ACCESSES` List all LiveChat auto-access rules in their evaluation order. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bots **Slug:** `LIVECHAT_LIST_BOTS` List only bots owned by the connected LiveChat app. Use List All Bots for the privileged license-wide inventory. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | array | No | Additional bot fields to include for each result. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bot Templates **Slug:** `LIVECHAT_LIST_BOT_TEMPLATES` List bot templates owned by a specified OAuth application client ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `owner_client_id` | string | Yes | Client ID of an application owned by the connected organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Canned Responses **Slug:** `LIVECHAT_LIST_CANNED_RESPONSES` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of results on this page. | | `page_id` | string | No | Continuation page ID returned as next_page_id by a previous call. | | `group_ids` | array | No | Group IDs to filter by; omitted uses groups accessible to the caller. | | `include_private` | boolean | No | Whether to include the caller's private canned responses. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Channels **Slug:** `LIVECHAT_LIST_CHANNELS` List summaries of communication channels used by the connected Text product. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Bans **Slug:** `LIVECHAT_LIST_CUSTOMER_BANS` List all active customer bans. Results can contain sensitive IP addresses and customer identifiers and should not be persisted unnecessarily. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Chats **Slug:** `LIVECHAT_LIST_CUSTOMER_CHATS` List one existing customer's chat summaries through LiveChat's server-side customer authorization bridge, returning one page at a time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum chat summaries on the first page; omit for the default of 10. | | `cursor` | string | No | Opaque next_cursor returned by a previous call. The documented limit and sort_order controls may also be provided. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `sort_order` | string ("asc" | "desc") | No | First-page order by latest-thread creation time; omit for descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Chat Threads **Slug:** `LIVECHAT_LIST_CUSTOMER_CHAT_THREADS` List threads from one existing customer's chat through LiveChat's server-side customer authorization bridge, returning one page at a time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum threads on the first page; omit for the default of 3. | | `cursor` | string | No | Opaque next_cursor returned by a previous call. It cannot be combined with min_events_count; limit and sort_order remain available. | | `chat_id` | string | Yes | Chat ID whose threads to list. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `sort_order` | string ("asc" | "desc") | No | First-page order; omit for newest threads first. | | `min_events_count` | integer | No | Minimum total events to include across the latest threads. Cannot be combined with limit. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Group Properties **Slug:** `LIVECHAT_LIST_CUSTOMER_GROUP_PROPERTIES` Read 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | ID of the group whose customer-visible properties to return. | | `name` | string | No | Exact property name to retrieve. | | `namespace` | string | No | Exact property namespace to retrieve. | | `organization_id` | string | Yes | LiveChat organization ID whose customer-visible properties to read. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Group Statuses **Slug:** `LIVECHAT_LIST_CUSTOMER_GROUP_STATUSES` Return chat availability statuses for selected LiveChat groups or all groups visible to an existing customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `group_ids` | array | No | Specific group IDs whose statuses to return. Provide exactly one selection: group_ids or all_groups=true, but not both. | | `all_groups` | boolean | No | Set true to return all visible groups. Provide exactly one selection: all_groups=true or group_ids, but not both. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer License Properties **Slug:** `LIVECHAT_LIST_CUSTOMER_LICENSE_PROPERTIES` Read 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Exact property name to retrieve. | | `namespace` | string | No | Exact property namespace to retrieve. | | `organization_id` | string | Yes | LiveChat organization ID whose customer-visible properties to read. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Greetings **Slug:** `LIVECHAT_LIST_GREETINGS` List 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Greetings per page; cannot be combined with page_id. | | `groups` | array | No | Group IDs to filter by; cannot be combined with page_id. | | `page_id` | string | No | Native page ID; cannot be combined with groups or limit. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Group Properties **Slug:** `LIVECHAT_LIST_GROUP_PROPERTIES` Read group-level property values for selected LiveChat groups or a property namespace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_ids` | array | Yes | Group IDs to read. Pass an empty list to return properties from all groups. | | `namespace` | string | No | Optional property namespace to return. | | `name_prefix` | string | No | Return only property names beginning with this prefix. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Groups **Slug:** `LIVECHAT_LIST_GROUPS` List all LiveChat groups, optionally requesting additional fields for each group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | array | No | Additional group fields to include for each result. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List License Properties **Slug:** `LIVECHAT_LIST_LICENSE_PROPERTIES` Read license-level property values, optionally narrowed to a namespace and property-name prefix. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `namespace` | string | No | Property namespace to return. | | `name_prefix` | string | No | Return only property names beginning with this prefix. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Property Definitions **Slug:** `LIVECHAT_LIST_PROPERTY_DEFINITIONS` List private and public LiveChat property definitions owned by a specified OAuth application client ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `owner_client_id` | string | Yes | Client ID of the application whose property definitions to list; the client ID must belong to the connected organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tags **Slug:** `LIVECHAT_LIST_TAGS` List LiveChat tags, optionally filtering by nested group IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filters` | object | No | Optional tag-list filters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhook Names **Slug:** `LIVECHAT_LIST_WEBHOOK_NAMES` List webhook actions supported by LiveChat Configuration API version 3.6, including their accepted filters and additional payload data. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhooks **Slug:** `LIVECHAT_LIST_WEBHOOKS` List webhooks registered for a specified OAuth application client ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `owner_client_id` | string | Yes | Client ID of the application whose registered webhooks to list; the client ID must belong to the connected organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Mark Events as Seen **Slug:** `LIVECHAT_MARK_EVENTS_AS_SEEN` Advance 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | Chat whose events should be marked seen. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `seen_up_to` | string | Yes | RFC 3339 timestamp through which events should be marked seen, creating the customer's read receipt up to this point. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Publish Property **Slug:** `LIVECHAT_PUBLISH_PROPERTY` Publish 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the private property to publish. | | `access_type` | array | Yes | Access levels granted to Client IDs other than owner_client_id. | | `owner_client_id` | string | Yes | Client ID that owns the property; it must belong to the connected organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reactivate Email **Slug:** `LIVECHAT_REACTIVATE_EMAIL` Reactivate 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Agent ID whose bounced external email address should be reactivated. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Register Property **Slug:** `LIVECHAT_REGISTER_PROPERTY` Register one private custom property definition for a LiveChat OAuth application. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Property name to register. | | `range` | object | No | Allowed inclusive integer range. Valid only when property_type is int and cannot be combined with domain. | | `access` | object | Yes | Access rules keyed by property location; at least one location and one user type per location are required. | | `domain` | array | No | Allowed property values. Every value must match property_type; cannot be combined with range. | | `description` | string | No | Human-readable property description. | | `default_value` | string | No | Default value matching property_type and any domain or range constraint. Allowed only for license or group properties. | | `property_type` | string ("int" | "string" | "bool" | "tokenized_string") | Yes | Value type enforced for the property. Use tokenized_string for searchable long text, not keywords. | | `owner_client_id` | string | Yes | Client ID of the application that will own the property; it must belong to the connected organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Register Webhook **Slug:** `LIVECHAT_REGISTER_WEBHOOK` Register one LiveChat webhook endpoint for an OAuth application and action. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Destination URL for webhook deliveries, up to 500 characters. | | `action` | 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") | Yes | Webhook action to register. Use List Webhook Names to confirm its currently advertised filters. | | `filters` | object | No | Action-specific filters advertised for the selected action by List Webhook Names. | | `secret_key` | string | Yes | Secret LiveChat sends with webhook deliveries for origin verification; it is sent only to LiveChat and never returned by this action. | | `description` | string | No | Human-readable webhook description. | | `webhook_type` | string ("bot" | "license") | Yes | Whether to register a bot or license webhook. Sent to LiveChat as type. | | `additional_data` | array | No | Additional payload data advertised for the selected action by List Webhook Names. | | `owner_client_id` | string | Yes | Client ID of the application that will own the webhook; it must belong to the connected organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request Agent Unsuspension **Slug:** `LIVECHAT_REQUEST_AGENT_UNSUSPENSION` Request 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request Email Verification **Slug:** `LIVECHAT_REQUEST_EMAIL_VERIFICATION` Send 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `callback_uri` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request Welcome Message **Slug:** `LIVECHAT_REQUEST_WELCOME_MESSAGE` Request 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Welcome message ID, when selecting a specific welcome message. | | `group_id` | integer | No | Group ID used to choose the welcome message and predicted routing. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `ai_agent_response_scope` | string ("message_and_questions" | "questions_only") | No | Whether an AI agent may provide the welcome message and questions or questions only. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Bot Secret **Slug:** `LIVECHAT_RESET_BOT_SECRET` Irreversibly 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot whose secret will be rotated. | | `owner_client_id` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Bot Template And Installed Bot Secrets **Slug:** `LIVECHAT_RESET_BOT_TEMPLATE_AND_INSTALLED_BOT_SECRETS` Irreversibly 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot template whose secret will be rotated. | | `owner_client_id` | string | Yes | Client ID that owns the template; it must belong to the organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Bot Template Secret **Slug:** `LIVECHAT_RESET_BOT_TEMPLATE_SECRET` Irreversibly 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot template whose secret will be rotated. | | `owner_client_id` | string | Yes | Client ID that owns the template; it must belong to the organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resume Chat **Slug:** `LIVECHAT_RESUME_CHAT` Resume 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat` | object | Yes | Archived chat and optional new thread data. | | `active` | boolean | No | Whether the newly created thread is active. Defaults to true. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `continuous` | boolean | No | New continuous-mode setting; omit to leave the setting unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Event **Slug:** `LIVECHAT_SEND_EVENT` Send 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event` | object | Yes | Documented Customer Chat event object. Preserve the fields required by the selected event type; the form event type is not supported by this action. | | `chat_id` | string | Yes | ID of the chat to receive the event. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `attach_to_last_thread` | boolean | No | For an inactive chat, attach the event to its last thread. If false, sending to an inactive chat fails. Ignored for active chats. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send File Event **Slug:** `LIVECHAT_SEND_FILE_EVENT` Upload 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Non-executable file to upload and deliver. Maximum size is 10,000,000 bytes. | | `chat_id` | string | Yes | ID of the chat to receive the file event. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `attach_to_last_thread` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Greeting Button Clicked **Slug:** `LIVECHAT_SEND_GREETING_BUTTON_CLICKED` Record that an existing customer clicked a specific button in an incoming LiveChat greeting. This writes interaction state for the live session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `button_id` | string | Yes | ID of the greeting button the customer clicked. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `greeting_unique_id` | string | Yes | Unique greeting instance ID from the incoming_greeting push. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Rich Message Postback **Slug:** `LIVECHAT_SEND_RICH_MESSAGE_POSTBACK` Send 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | ID of the chat containing the rich message. | | `event_id` | string | Yes | ID of the rich-message event. | | `postback` | object | Yes | Button postback payload to send. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `thread_id` | string | Yes | ID of the thread containing the event. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Sneak Peek **Slug:** `LIVECHAT_SEND_SNEAK_PEEK` Send 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | ID of the chat to receive the sneak peek. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `sneak_peek_text` | string | Yes | Transient text to expose to the live chat before it is sent. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Customer Session Fields **Slug:** `LIVECHAT_SET_CUSTOMER_SESSION_FIELDS` Replace an existing LiveChat customer's ordered session fields. This mutates customer session/profile data and the values may contain PII. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `session_fields` | array | Yes | Up to 100 ordered custom object-enclosed key/value pairs. This replaces the supplied session fields and values may contain customer PII. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Chat **Slug:** `LIVECHAT_START_CHAT` Start 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat` | object | No | Optional initial chat data. | | `active` | boolean | No | Whether to create an active thread. Defaults to true. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `continuous` | boolean | No | Whether to start a continuous chat, which does not require an online group. Defaults to false. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Suspend Agent **Slug:** `LIVECHAT_SUSPEND_AGENT` Suspend 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the agent to suspend. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unban Customer **Slug:** `LIVECHAT_UNBAN_CUSTOMER` Lift a customer ban by IP address or customer ID. Warning: this restores the customer's access to the connected LiveChat license. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ip` | string | No | IP address to unban. Provide exactly one of ip and customer_id. | | `customer_id` | string | No | Unique customer identifier to unban. Provide exactly one of ip and customer_id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unregister Property **Slug:** `LIVECHAT_UNREGISTER_PROPERTY` Permanently remove one custom property definition owned by an OAuth application. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Registered property name to remove. | | `owner_client_id` | string | Yes | Client ID of the application that owns the property. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unregister Webhook **Slug:** `LIVECHAT_UNREGISTER_WEBHOOK` Permanently remove one webhook registration owned by a LiveChat OAuth application. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook_id` | string | Yes | Webhook registration ID to remove. | | `owner_client_id` | string | Yes | Client ID of the application that owns the webhook. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unsuspend Agent **Slug:** `LIVECHAT_UNSUSPEND_AGENT` Unsuspend 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the agent to unsuspend. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Agent **Slug:** `LIVECHAT_UPDATE_AGENT` Update 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the agent to update. | | `role` | string ("viceowner" | "administrator" | "normal") | No | Replacement agent role. | | `groups` | array | No | Replacement groups for the agent and their priority in each. | | `mobile` | string | No | Replacement mobile number. | | `job_title` | string | No | Replacement job title. | | `login_status` | string ("accepting chats" | "not accepting chats") | No | Replacement default status immediately after login. | | `notifications` | array | No | Replacement set of enabled notifications. | | `work_scheduler` | object | No | Replacement work scheduler. | | `max_chats_count` | integer | No | Replacement maximum number of concurrent chats. | | `email_subscriptions` | array | No | Replacement summary-email subscriptions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Auto Access **Slug:** `LIVECHAT_UPDATE_AUTO_ACCESS` Update or reorder an auto-access rule. Changes immediately affect customer access routing, so use a confirmed disposable or intended rule ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the auto-access rule to modify. | | `access` | object | No | Replacement destination access. | | `next_id` | string | No | Move this rule before the specified rule ID; an empty string moves it last. Omit this field to preserve ordering. | | `conditions` | object | No | Replacement conditions; set at least one of url, domain, or geolocation. | | `description` | string | No | Replacement description. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Bot **Slug:** `LIVECHAT_UPDATE_BOT` Update 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot to update. | | `name` | string | No | Replacement bot display name. | | `type` | string | No | Replacement custom bot category or identifier. | | `avatar` | string | No | Replacement bot avatar URL. | | `groups` | array | No | Replacement groups and routing priorities for the bot. | | `job_title` | string | No | Replacement bot job title. | | `work_scheduler` | object | No | Replacement working schedule for the bot. | | `max_chats_count` | integer | No | Replacement maximum number of incoming chats routed to the bot. | | `default_group_priority` | string ("first" | "normal" | "last" | "supervisor") | No | Replacement default group routing priority. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Bot Template **Slug:** `LIVECHAT_UPDATE_BOT_TEMPLATE` Fully 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot template to update. | | `name` | string | No | Replacement template display name. Omitting this optional replacement field resets or clears it to the provider default. | | `avatar` | string | No | Replacement template avatar URL. Omitting this optional replacement field resets or clears it to the provider default. | | `job_title` | string | No | Replacement job title for installed bots. Omitting this optional replacement field resets or clears it to the provider default. | | `max_chats_count` | integer | No | Replacement maximum incoming chats for bots based on the template. Omitting this optional replacement field resets or clears it to the provider default. | | `owner_client_id` | string | Yes | Client ID that owns the template; it must belong to the organization. | | `default_group_priority` | string ("first" | "normal" | "last" | "supervisor") | No | Replacement default routing priority for installed bots. Omitting this optional replacement field resets or clears it to the provider default. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Canned Response **Slug:** `LIVECHAT_UPDATE_CANNED_RESPONSE` Update an existing canned response while preserving omitted fields. Changing its group or privacy setting changes who can access it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | ID of the canned response to update. | | `tags` | array | No | Replacement tag list. | | `text` | string | No | Replacement text. LiveChat sanitizes it and rejects content that becomes empty after sanitization. | | `group_id` | integer | No | Replacement owning group ID. | | `is_private` | boolean | No | Whether the canned response should be private instead of public. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Chat Properties **Slug:** `LIVECHAT_UPDATE_CHAT_PROPERTIES` Set registered custom property values on a live customer chat. This mutates chat state and values may contain PII. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the live chat whose properties will be changed. | | `client_id` | string | Yes | Non-secret client ID from the server-side LiveChat app Authorization block. | | `entity_id` | string | Yes | 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. | | `properties` | object | Yes | Property values grouped by registered namespace. Values may contain customer PII. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Company Details **Slug:** `LIVECHAT_UPDATE_COMPANY_DETAILS` Update 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | Company URL. | | `city` | string | No | Company city. | | `phone` | string | No | Company phone number. | | `state` | string | No | Company state. | | `enrich` | boolean | No | Whether LiveChat should try to fill empty fields by searching for the company domain. | | `street` | string | No | Company street address. | | `company` | string | No | Company name. | | `country` | string | No | Company country. | | `audience` | string | No | Company audience. | | `province` | string | No | Company province. | | `postal_code` | string | No | Company postal code. | | `chat_purpose` | string | No | Company chat purpose. | | `company_size` | string | No | Company size. | | `invoice_name` | string | No | Invoice recipient name. | | `invoice_email` | string | No | Invoice email address. | | `tax_identification_number` | string | No | Company tax identification number (NIP). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Customer **Slug:** `LIVECHAT_UPDATE_CUSTOMER` Partially update an existing LiveChat customer profile. This writes PII and may change omnichannel identity matching; omitted fields remain unchanged. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Customer name. This is PII. | | `email` | string | No | Customer email address. This is PII. | | `avatar` | string | No | Customer avatar URL. | | `address` | object | No | Customer postal address. This is PII. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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. | | `omnichannel` | object | No | Omnichannel identity links to change; changing these may affect identity matching. | | `phone_number` | string | No | Customer phone number in E.164 format. This is PII. | | `session_fields` | array | No | Ordered custom object-enclosed key/value pairs. Values may contain PII and replace the supplied customer session fields. | | `suggested_email` | string | No | Unconfirmed email inferred from tracked activity. Supply null or an empty value to clear only this suggestion. This is PII. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Event Properties **Slug:** `LIVECHAT_UPDATE_EVENT_PROPERTIES` Set registered custom property values on a live customer-chat event. This mutates event state and values may contain PII. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | ID of the chat containing the event. | | `event_id` | string | Yes | ID of the event whose properties will be changed. | | `client_id` | string | Yes | Non-secret client ID from the server-side LiveChat app Authorization block. | | `entity_id` | string | Yes | 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. | | `thread_id` | string | Yes | ID of the thread containing the event. | | `properties` | object | Yes | Property values grouped by registered namespace. Values may contain customer PII. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Greeting **Slug:** `LIVECHAT_UPDATE_GREETING` Update a greeting while preserving omitted fields. Rule, content, or active changes affect matching visitors immediately; deactivate before structural editing when appropriate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | ID of the greeting to update. | | `name` | string | No | Replacement greeting name. | | `type` | string ("normal" | "announcement") | No | Replacement greeting type. | | `rules` | array | No | Replacement trigger-rule list. | | `active` | boolean | No | Whether the greeting should be active. | | `properties` | object | No | Replacement provider-defined greeting properties. | | `active_from` | string | No | Replacement RFC 3339 activation date-time. | | `active_until` | string | No | Replacement RFC 3339 deactivation date-time. | | `rich_message` | object | No | Replacement structured rich-message content. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Group **Slug:** `LIVECHAT_UPDATE_GROUP` Update the name, language, or complete agent-priority map of an existing LiveChat group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Replacement group name, up to 180 characters. | | `group_id` | integer | Yes | Group ID to update. | | `language_code` | string | No | Replacement group language code. | | `agent_priorities` | object | No | Complete replacement map from agent IDs to routing priorities. Allowed priorities are first, normal, last, and supervisor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Group Properties **Slug:** `LIVECHAT_UPDATE_GROUP_PROPERTIES` Set one or more custom property values on a LiveChat group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | Group ID whose property values to set. | | `properties` | object | Yes | Group property values grouped by namespace and then property name. Each property must already be registered for group access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Installed Bots From Template **Slug:** `LIVECHAT_UPDATE_INSTALLED_BOTS_FROM_TEMPLATE` Fully 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the bot template to update. | | `name` | string | No | Replacement template display name. Omitting this optional replacement field resets or clears it to the provider default. | | `avatar` | string | No | Replacement template avatar URL. Omitting this optional replacement field resets or clears it to the provider default. | | `job_title` | string | No | Replacement job title for installed bots. Omitting this optional replacement field resets or clears it to the provider default. | | `max_chats_count` | integer | No | Replacement maximum incoming chats for bots based on the template. Omitting this optional replacement field resets or clears it to the provider default. | | `owner_client_id` | string | Yes | Client ID that owns the template; it must belong to the organization. | | `default_group_priority` | string ("first" | "normal" | "last" | "supervisor") | No | Replacement default routing priority for installed bots. Omitting this optional replacement field resets or clears it to the provider default. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update License Properties **Slug:** `LIVECHAT_UPDATE_LICENSE_PROPERTIES` Set one or more license-level custom property values grouped by namespace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `properties` | object | Yes | License property values grouped by namespace and then property name. Each property must already be registered for license access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Tag **Slug:** `LIVECHAT_UPDATE_TAG` Update a LiveChat tag identified by its exact case-sensitive name. When provided, group_ids replaces the tag's group assignment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Exact case-sensitive name of the tag to update. | | `group_ids` | array | No | Complete replacement group assignment for the tag; may be empty. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Thread Properties **Slug:** `LIVECHAT_UPDATE_THREAD_PROPERTIES` Set registered custom property values on a live customer-chat thread. This mutates thread state and values may contain PII. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chat_id` | string | Yes | ID of the chat containing the thread. | | `client_id` | string | Yes | Non-secret client ID from the server-side LiveChat app Authorization block. | | `entity_id` | string | Yes | 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. | | `thread_id` | string | Yes | ID of the thread whose properties will be changed. | | `properties` | object | Yes | Property values grouped by registered namespace. Values may contain customer PII. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload File **Slug:** `LIVECHAT_UPLOAD_FILE` Upload 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File to upload as multipart/form-data. Maximum size is 10,000,000 bytes. LiveChat rejects executable files. | | `client_id` | string | Yes | Client ID from the Authorization block of the server-side LiveChat app in the Text Developer Console. This is a non-secret application identifier. | | `entity_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |