rakazo
6.2k
Get started

LiveChat

Manage LiveChat agents, groups, bots, webhooks, properties, and customer conversations through server-side OAuth.

111 actionsSign in with LiveChat

Connect LiveChat

What your bot can do in LiveChat

Looks up

  • Check Product Limits for PlanRead which current organization resources exceed a selected LiveChat plan's limits.
  • Get AgentReturn one LiveChat agent by ID, including any explicitly requested optional fields.
  • Get BotReturn one LiveChat bot by ID with explicitly requested optional fields.
  • Get CustomerReturn the customer profile for an explicit existing LiveChat entity through the server-side customer authorization bridge.
  • Get Customer ChatReturn one existing customer's LiveChat chat and either its latest thread or a specified thread.
  • Get Customer ConfigurationReturn versioned forms, buttons, integrations, and readable properties for a LiveChat customer group.
  • Get Customer FormReturn the enabled pre-chat or post-chat form for one LiveChat group.
  • Get Customer LocalizationReturn versioned customer-facing localization phrases for a LiveChat group and language through LiveChat's public Customer Chat endpoint.
  • Get Dynamic Customer ConfigurationReturn current customer-facing widget availability and the version identifiers needed for detailed configuration and localization reads.
  • Get GreetingGet one LiveChat greeting, including its rules and rich-message structure.
Show 27 more
  • Get GroupReturn one LiveChat group by ID, including any explicitly requested optional fields.
  • Get License Webhooks StateReturn whether webhook delivery is enabled for the connected LiveChat license.
  • Get Predicted AgentReturn whether a new chat for an existing customer is predicted to queue and the agent predicted to receive it, when available.
  • Get Product SourceReturn the source parameters supplied when the Text product was activated.
  • Get URL PreviewReturn LiveChat-hosted preview image URLs for a public webpage without changing chat state.
  • List AgentsList LiveChat agents, optionally filtering by group membership or suspension state.
  • List All BotsList every bot in the LiveChat license, including bots not owned by the connected app.
  • List All Private Canned ResponsesReturn one page including every private canned response across the requested LiveChat groups.
  • List Auto AccessesList all LiveChat auto-access rules in their evaluation order.
  • List Bot TemplatesList bot templates owned by a specified OAuth application client ID.
  • List BotsList only bots owned by the connected LiveChat app.
  • List Canned ResponsesReturn one page of canned responses accessible to the caller and a next_page_id for explicit continuation.
  • List ChannelsList summaries of communication channels used by the connected Text product.
  • List Customer BansList all active customer bans.
  • List Customer Chat ThreadsList threads from one existing customer's chat through LiveChat's server-side customer authorization bridge, returning one page at a time.
  • List Customer ChatsList one existing customer's chat summaries through LiveChat's server-side customer authorization bridge, returning one page at a time.
  • List Customer Group PropertiesRead the custom property values a customer may access for one LiveChat group.
  • List Customer Group StatusesReturn chat availability statuses for selected LiveChat groups or all groups visible to an existing customer.
  • List Customer License PropertiesRead the license property values visible to a LiveChat customer.
  • List GreetingsList a bounded page of LiveChat greetings, optionally filtered by group.
  • List Group PropertiesRead group-level property values for selected LiveChat groups or a property namespace.
  • List GroupsList all LiveChat groups, optionally requesting additional fields for each group.
  • List License PropertiesRead license-level property values, optionally narrowed to a namespace and property-name prefix.
  • List Property DefinitionsList private and public LiveChat property definitions owned by a specified OAuth application client ID.
  • List TagsList LiveChat tags, optionally filtering by nested group IDs.
  • List Webhook NamesList webhook actions supported by LiveChat Configuration API version 3.6, including their accepted filters and additional payload data.
  • List WebhooksList webhooks registered for a specified OAuth application client ID.

Takes action

  • Accept GreetingAccept an incoming LiveChat greeting for an existing customer and mark that greeting as seen in the customer's live session.
  • Approve AgentApprove a licensed LiveChat agent so they can use the application.
  • Cancel GreetingCancel an incoming LiveChat invitation for an existing customer.
  • Create AgentCreate a normal-role licensed LiveChat user who must await approval.
  • Create Auto AccessAdd an ordered LiveChat auto-access rule.
  • Create BotCreate a LiveChat bot and return its write-once secret.
  • Create Bot TemplateCreate a bot template for an application client ID and return its write-once secret.
  • Create Bot Template Across InstallationsCreate a LiveChat bot template and also create a bot from it on every license where the app is already installed.
  • Create Canned ResponseCreate a group-owned LiveChat canned response.
  • Create GreetingCreate a LiveChat greeting with trigger rules and optional rich content.
Show 64 more
  • Create GroupCreate a LiveChat routing group with its initial language and agent-priority map.
  • Create Privileged AgentCreate a licensed LiveChat agent while explicitly bypassing approval and/or assigning an elevated administrator or viceowner role.
  • Create TagCreate a LiveChat tag and optionally assign it to groups.
  • Deactivate ChatDeactivate a LiveChat chat by closing its currently open thread.
  • Delete AgentPermanently delete a licensed LiveChat agent.
  • Delete Auto AccessPermanently delete an auto-access rule.
  • Delete BotPermanently delete a LiveChat bot.
  • Delete Bot TemplatePermanently delete only a bot template.
  • Delete Bot Template And Installed BotsPermanently delete a LiveChat bot template and every bot installed from it across all licenses.
  • Delete Canned ResponsePermanently delete one canned response by ID, removing it from agent use.
  • Delete Chat PropertiesPermanently delete selected registered property values from a live customer chat.
  • Delete EventDelete one event from a specified LiveChat chat and thread.
  • Delete Event PropertiesPermanently delete selected registered property values from a live customer-chat event.
  • Delete GreetingPermanently delete a greeting, immediately stopping it from appearing to new matching visitors.
  • Delete GroupPermanently delete one LiveChat group by ID.
  • Delete Group PropertiesDelete selected custom property values from one LiveChat group without unregistering their definitions.
  • Delete License PropertiesDelete selected license-level custom property values without unregistering their definitions.
  • Delete TagPermanently delete the exact case-sensitive LiveChat tag, removing it from workflows that rely on that tag.
  • Delete Thread PropertiesPermanently delete selected registered property values from a live customer-chat thread.
  • Disable License WebhooksDisable all webhooks across the connected LiveChat license.
  • Enable License WebhooksEnable webhooks across the connected LiveChat license after they were explicitly disabled.
  • Evaluate GoalsTrigger LiveChat goal evaluation for an offline customer.
  • Issue Bot TokenIssue a sensitive, non-revocable bot bearer token valid for 24 hours.
  • Mark Events as SeenAdvance an existing customer's seen state in a LiveChat chat through an RFC 3339 timestamp.
  • Publish PropertyPublish a private property for access by tokens belonging to any Client ID.
  • Reactivate EmailReactivate a bounced external email address for one LiveChat agent.
  • Register PropertyRegister one private custom property definition for a LiveChat OAuth application.
  • Register WebhookRegister one LiveChat webhook endpoint for an OAuth application and action.
  • Request Agent UnsuspensionRequest unsuspension for the connected suspended agent.
  • Request Email VerificationSend a verification email to an existing LiveChat customer.
  • Request Welcome MessageRequest an asynchronous welcome message for an existing logged-in customer.
  • Reset Bot SecretIrreversibly rotate a bot secret and return the sensitive replacement.
  • Reset Bot Template And Installed Bot SecretsIrreversibly rotate a LiveChat bot template secret and set the replacement on every installed bot based on it across all licenses.
  • Reset Bot Template SecretIrreversibly rotate only a bot template secret and return the sensitive replacement.
  • Resume ChatResume an archived LiveChat chat for an existing customer entity.
  • Send EventSend one event into a real LiveChat chat for an existing customer.
  • Send File EventUpload one non-executable file of at most 10,000,000 bytes and irreversibly deliver it as a file event in an existing LiveChat chat.
  • Send Greeting Button ClickedRecord that an existing customer clicked a specific button in an incoming LiveChat greeting.
  • Send Rich Message PostbackSend a button postback for an existing rich-message event.
  • Send Sneak PeekSend transient typed content into a real LiveChat chat before the customer submits it as a message.
  • Set Customer Session FieldsReplace an existing LiveChat customer's ordered session fields.
  • Start ChatStart a new LiveChat chat for an existing customer entity.
  • Suspend AgentSuspend a licensed LiveChat agent.
  • Unban CustomerLift a customer ban by IP address or customer ID.
  • Unregister PropertyPermanently remove one custom property definition owned by an OAuth application.
  • Unregister WebhookPermanently remove one webhook registration owned by a LiveChat OAuth application.
  • Unsuspend AgentUnsuspend a licensed LiveChat agent.
  • Update AgentUpdate a licensed LiveChat agent.
  • Update Auto AccessUpdate or reorder an auto-access rule.
  • Update BotUpdate a LiveChat bot.
  • Update Bot TemplateFully replace a LiveChat bot template for future installations.
  • Update Canned ResponseUpdate an existing canned response while preserving omitted fields.
  • Update Chat PropertiesSet registered custom property values on a live customer chat.
  • Update Company DetailsUpdate license-level company details.
  • Update CustomerPartially update an existing LiveChat customer profile.
  • Update Event PropertiesSet registered custom property values on a live customer-chat event.
  • Update GreetingUpdate a greeting while preserving omitted fields.
  • Update GroupUpdate the name, language, or complete agent-priority map of an existing LiveChat group.
  • Update Group PropertiesSet one or more custom property values on a LiveChat group.
  • Update Installed Bots From TemplateFully replace a LiveChat bot template and propagate the replacement to every bot installed from it across all licenses.
  • Update License PropertiesSet one or more license-level custom property values grouped by namespace.
  • Update TagUpdate a LiveChat tag identified by its exact case-sensitive name.
  • Update Thread PropertiesSet registered custom property values on a live customer-chat thread.
  • Upload FileUpload one non-executable file of at most 10,000,000 bytes for later use in a Customer Chat event.

More communication apps