UChat integration
UChat is a chatbot and omnichannel inbox platform (WhatsApp, Facebook, Instagram, Telegram, web chat, SMS, email and more). Manage a bot's subscribers (create, update, tag, label, set user fields, opt in or out), send them text, SMS, email, WhatsApp templates, rich content or a sub flow, broadcast to lists, tags or segments, hand chats to agents, read chat history and analytics, and run the built-in shop (products, variants, carts, orders, discount codes), bookings and ticket lists. Not exposed: integration settings that hold third-party keys (OpenAI, Shopify, S3...), AI agent, MCP server and transcription settings, knowledge-base embeddings, the media library, workspace and widget settings, reply shortcuts, flow templates, inbound webhook URLs, Facebook utility templates, shop tags, types, vendors, locations and hours, and account password or notification routes; single-item tag and field routes are covered by their bulk twins. Authentication is a Bearer API token created under the profile menu, API keys; each token is bound to one workspace and one bot and carries permissions (Manage Flow, Manage Team, Send Message) named on each tool. UChat limits the API to 1000 calls per hour.
Say what should happen.
The workflow builds itself.
What you can do with UChat
Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.
Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.
Subscriber, 13 operations
count_subscribers_by_statusCount subscribers by statusGETReturns how many subscribers of the current flow are in each chat status (open, pending, spam, done). Needs an API token with the Manage Flow permission.create_subscriberCreate subscriberPOSTCreates a subscriber in the current bot from a phone number or an email (at least one is needed) and returns it with its user_ns. Needs an API token with the Manage Flow permission.create_subscribersCreate subscribersPOSTCreates up to 100 subscribers in one call, each with a phone or email and optional user fields and tags. Needs an API token with the Manage Flow permission.delete_subscriberDelete subscriberDELETEDeletes a subscriber from the current bot. Irreversible. Needs an API token with the Manage Flow permission.get_subscriberGet subscriberGETReturns a subscriber by user_ns: profile, opt-ins, last interaction, tags and user field values. Needs an API token with the Manage Flow permission.get_subscriber_by_user_idGet subscriber by user idGETReturns a subscriber by its id on the channel (Facebook user id, WhatsApp number id, WeChat id...): profile, opt-ins, tags and user field values. Needs an API token with the Manage Flow permission.list_subscribersList subscribersGETLists the current bot's subscribers, searchable by name, phone, email, channel, opt-in, recent activity, segment, tag, label, custom event or user field value. Needs an API token with the Manage Flow permission.list_workspace_subscribersList workspace subscribersGETLists subscribers (bot users) at workspace level, searchable by name, phone, email, channel, opt-in and recent activity. list_subscribers searches the token's bot. Needs an API token with the Manage Team permission.opt_in_subscriber_emailOpt in subscriber emailPOSTOpt-in Email. Needs an API token with the Manage Flow permission.opt_in_subscriber_smsOpt in subscriber smsPOSTOpt-in SMS. Needs an API token with the Manage Flow permission.opt_out_subscriber_emailOpt out subscriber emailDELETEOpt-out Email. Needs an API token with the Manage Flow permission.opt_out_subscriber_smsOpt out subscriber smsDELETEOpt-out SMS. Needs an API token with the Manage Flow permission.pause_bot_for_subscriberPause bot for subscriberPOSTPauses bot automation for one subscriber for a number of minutes, for example while a human agent replies. Needs an API token with the Manage Flow permission.
Broadcast, 9 operations
broadcast_sub_flowBroadcast sub flowPOSTBroadcasts a sub flow to up to 200 subscribers listed by user_ns, now or at scheduled_time. Messages go out to real contacts. Needs an API token with the Manage Flow permission.broadcast_sub_flow_by_segmentBroadcast sub flow by segmentPOSTBroadcasts a sub flow to every subscriber of up to 10 segments, now or at scheduled_time. Messages go out to real contacts. Needs an API token with the Manage Flow permission.broadcast_sub_flow_by_tagBroadcast sub flow by tagPOSTBroadcasts a sub flow to every subscriber carrying up to 10 tags (minus exclude_tags), now or at scheduled_time. Messages go out to real contacts. Needs an API token with the Manage Flow permission.broadcast_sub_flow_by_user_idBroadcast sub flow by user idPOSTBroadcasts a sub flow to up to 200 subscribers listed by channel user id, now or at scheduled_time. Messages go out to real contacts. Needs an API token with the Manage Flow permission.broadcast_whatsapp_template_by_tagBroadcast whatsapp template by tagPOSTBroadcasts an approved WhatsApp template (from list_whatsapp_templates) to subscribers carrying up to 10 tags, now or at scheduled_time. Messages go out to real contacts. Needs an API token with the Manage Flow permission.broadcast_whatsapp_template_by_user_idBroadcast whatsapp template by user idPOSTBroadcasts an approved WhatsApp template (from list_whatsapp_templates) to up to 200 subscribers by user id, now or at scheduled_time. Messages go out to real contacts. Needs an API token with the Manage Flow permission.cancel_broadcastCancel broadcastDELETECancels every pending recipient of a new, scheduled or sending broadcast (broadcast_ns from list_broadcasts) in the current flow. Needs an API token with the Send Message permission.delete_broadcastDelete broadcastDELETEDeletes a cancelled broadcast and its recipient records from the current flow (cancel it first with cancel_broadcast). Needs an API token with the Send Message permission.list_broadcastsList broadcastsGETLists the broadcasts of the current flow, optionally filtered by status. UChat documents no response fields for this call. Needs an API token with the Send Message permission.
Booking, 8 operations
cancel_bookingCancel bookingPOSTCancels a booking, with an optional reason and notes. Needs an API token with the Manage Team permission.complete_bookingComplete bookingPOSTMarks a booking as completed. Needs an API token with the Manage Team permission.confirm_bookingConfirm bookingPOSTConfirms a pending booking. Needs an API token with the Manage Team permission.create_bookingCreate bookingPOSTBooks a booking service slot for a subscriber; start_time must be a free slot from list_booking_available_slots unless outside_hours is true. Fires the same reminders and calendar write as a chat booking.delete_bookingDelete bookingDELETEDeletes a booking. Unlike cancel_booking, a delete fires no event. Needs an API token with the Manage Team permission.get_bookingGet bookingGETGet a Booking. Needs an API token with the Manage Team permission.list_bookingsList bookingsGETGet list of Bookings, ordered by id. Needs an API token with the Manage Team permission.mark_booking_no_showMark booking no showPOSTMarks a booking as no show; a completed booking can still be marked. Needs an API token with the Manage Team permission.
Discount code, 6 operations
create_discount_codeCreate discount codePOSTCreates a shop discount code (percentage, fixed amount or free shipping) valid between start_time and end_time. Needs an API token with the Manage Team permission.delete_discount_codeDelete discount codeDELETEDelete discount code. Needs an API token with the Manage Team permission.delete_discount_code_by_codeDelete discount code by codeDELETEDelete discount code by code. Needs an API token with the Manage Team permission.get_discount_codeGet discount codeGETReturns a shop discount code by its id (from list_discount_codes). Needs an API token with the Manage Team permission.get_discount_code_by_codeGet discount code by codeGETReturns a shop discount code looked up by its code text. Needs an API token with the Manage Team permission.list_discount_codesList discount codesGETGet list of discount codes. Needs an API token with the Manage Team permission.
Closing note, 5 operations
create_closing_noteCreate closing notePOSTCreate a closing note for the current flow. Needs an API token with the Manage Flow permission.delete_closing_noteDelete closing noteDELETEDelete a closing note from the current flow. Needs an API token with the Manage Flow permission.get_closing_noteGet closing noteGETGet a closing note from the current flow. Needs an API token with the Manage Flow permission.list_closing_notesList closing notesGETGet closing notes for the current flow. Needs an API token with the Manage Flow permission.list_subscriber_closing_notesList subscriber closing notesGETLists closing notes recorded on subscribers' conversations in the current flow, filtered by subscriber, note or time; page on with start_id. Needs an API token with the Manage Flow permission.
Agent group, 4 operations
create_agent_groupCreate agent groupPOSTcreate new agent group. Needs an API token with the Manage Team permission.delete_agent_groupDelete agent groupDELETEDelete agent group. Needs an API token with the Manage Team permission.get_agent_groupGet agent groupGETGet agent group information and members. Needs an API token with the Manage Team permission.list_agent_groupsList agent groupsGETGet list of Agent Groups. Needs an API token with the Manage Team permission.
Bot field, 4 operations
create_bot_fieldCreate bot fieldPOSTCreates a bot field (a flow-wide variable) with a name, type and initial value. Needs an API token with the Manage Flow permission.delete_bot_fieldDelete bot fieldDELETEDelete bot field. Needs an API token with the Manage Flow permission.delete_bot_field_by_nameDelete bot field by nameDELETEDelete bot field by name. Needs an API token with the Manage Flow permission.list_bot_fieldsList bot fieldsGETGet list of bot fields by flow. Needs an API token with the Manage Flow permission.
Cart, 4 operations
add_to_subscriber_cartAdd to subscriber cartPOSTAdds a product variant to a subscriber's shopping cart. Needs an API token with the Manage Flow permission.checkout_subscriber_cartCheckout subscriber cartPOSTChecks out a subscriber's shopping cart and marks it as paid, recording shipping and contact details. Needs an API token with the Manage Flow permission.empty_subscriber_cartEmpty subscriber cartDELETEEmpty subscriber shopping cart items. Needs an API token with the Manage Flow permission.get_subscriber_cartGet subscriber cartGETReturns a subscriber's shopping cart: items, number of items and total price. Needs an API token with the Manage Flow permission.
Custom event, 4 operations
get_custom_event_summaryGet custom event summaryGETReturns totals and daily stats of one custom event (event_ns from list_custom_events) over a date range, default yesterday. Needs an API token with the Manage Flow permission.list_custom_event_dataList custom event dataGETLists the logged occurrences of one custom event (event_ns from list_custom_events) in a time range; page on with start_id. Needs an API token with the Manage Flow permission.list_custom_eventsList custom eventsGETGet list of custom events by flow. Needs an API token with the Manage Flow permission.log_custom_eventLog custom eventPOSTRecords a custom event (for example a purchase) on a subscriber, with an optional text, price or number value. Needs an API token with the Manage Flow permission.
Label, 4 operations
create_labelCreate labelPOSTcreate new label. Needs an API token with the Manage Team permission.delete_labelDelete labelDELETEDelete label. Needs an API token with the Manage Team permission.delete_label_by_nameDelete label by nameDELETEDelete label by label name. Needs an API token with the Manage Team permission.list_labelsList labelsGETGet list of labels. Needs an API token with the Manage Team permission.
Product, 4 operations
create_productCreate productPOSTCreates a shop product, optionally with up to two variant options (for example color and size) and its variants. Needs an API token with the Manage Team permission.delete_productDelete productDELETEDelete product. Needs an API token with the Manage Team permission.get_productGet productGETReturns a shop product by its id (from list_products), with its variants. Needs an API token with the Manage Team permission.list_productsList productsGETGet list of products. Needs an API token with the Manage Team permission.
Product variant, 4 operations
create_product_variantCreate product variantPOSTCreate new product variant. Needs an API token with the Manage Team permission.delete_product_variantDelete product variantDELETEDelete product variant. Needs an API token with the Manage Team permission.get_product_variantGet product variantGETReturns one variant of a shop product. Needs an API token with the Manage Team permission.list_product_variantsList product variantsGETGet list of product variants. Needs an API token with the Manage Team permission.
Tag, 4 operations
create_tagCreate tagPOSTCreates a tag in the current flow and returns its tag_ns. Needs an API token with the Manage Flow permission.delete_tagDelete tagDELETEDelete tag. Needs an API token with the Manage Flow permission.delete_tag_by_nameDelete tag by nameDELETEDelete tag by tag name. Needs an API token with the Manage Flow permission.list_tagsList tagsGETGet list of tags by flow. Needs an API token with the Manage Flow permission.
User field, 4 operations
create_user_fieldCreate user fieldPOSTCreates a user field (a per-subscriber custom field) in the current flow. Needs an API token with the Manage Flow permission.delete_user_fieldDelete user fieldDELETEDelete user field. Needs an API token with the Manage Flow permission.delete_user_field_by_nameDelete user field by nameDELETEDelete user field by name. Needs an API token with the Manage Flow permission.list_user_fieldsList user fieldsGETGet list of user fields by flow. Needs an API token with the Manage Flow permission.
Order, 3 operations
create_orderCreate orderPOSTCreates a shop order for a subscriber (user_ns) with product variant items, shipping and payment details. Needs an API token with the Manage Flow permission.get_orderGet orderGETReturns a shop order by its id (from list_orders). Needs an API token with the Manage Team permission.list_ordersList ordersGETGet list of orders. Needs an API token with the Manage Team permission.
Subscriber tag, 3 operations
add_subscriber_tagsAdd subscriber tagsPOSTAdd tags to subscriber, up to 20 tags. Needs an API token with the Manage Flow permission.add_subscriber_tags_by_nameAdd subscriber tags by namePOSTAdd tags by tag name to subscriber, up to 20 tags. Needs an API token with the Manage Flow permission.list_subscriber_tagsList subscriber tagsGETLists tag assignments on subscribers of the current flow, filtered by subscriber or tag; page on with start_id. Needs an API token with the Manage Flow permission.
Ticket, 3 operations
create_ticketCreate ticketPOSTCreates a ticket in a ticket list for a subscriber (user_ns), with title, assignee and the list's custom columns (text1-5, select1-5, number, rating, date fields). Needs an API token with the Manage Team permission.delete_ticketDelete ticketDELETEDeletes a ticket from a ticket list. Needs an API token with the Manage Team permission.list_ticketsList ticketsGETLists the tickets of a ticket list, filterable by title, bot, subscriber, assignee, creator and column values; page on with page or start_id. Needs an API token with the Manage Team permission.
Whatsapp template, 3 operations
create_whatsapp_templateCreate whatsapp templatePOSTCreates a WhatsApp message template for the bot's WhatsApp account, with its name, language, category and components in Meta's template format. Needs an API token with the Manage Flow permission.delete_whatsapp_templateDelete whatsapp templateDELETEDelete Whatsapp template. Needs an API token with the Manage Flow permission.list_whatsapp_templatesList whatsapp templatesPOSTLists the WhatsApp message templates of the current bot with their namespace, name, language and status. A read. Needs an API token with the Manage Flow permission.
Booking service, 2 operations
get_booking_serviceGet booking serviceGETGet booking service opening hours, settings, reminders and follow-ups. Needs an API token with the Manage Team permission.list_booking_servicesList booking servicesGETGet list of Booking Services. Needs an API token with the Manage Team permission.
Chat, 2 operations
assign_agent_group_to_chatAssign agent group to chatPOSTAssign agent group to chat. Needs an API token with the Manage Flow permission.assign_agent_to_chatAssign agent to chatPOSTAssign agent to chat. Needs an API token with the Manage Flow permission.
Chat message, 2 operations
get_chat_messages_by_midsGet chat messages by midsPOSTReturns up to 100 chat messages by their message ids (mid). Message type: in (from the subscriber), out (from the bot), agent (from a human agent). A read. Needs an API token with the Manage Flow permission.list_chat_messagesList chat messagesGETLists a subscriber's chat messages (by user_ns or user_id) from the last month. Message type: in (from the subscriber), out (from the bot), agent (from a human agent), note, system. Needs an API token with the Manage Flow permission.
Sub flow, 2 operations
delete_sub_flowDelete sub flowDELETEDeletes a sub flow (sub_flow_ns from list_sub_flows) from the current bot. Irreversible. Needs an API token with the Manage Flow permission.list_sub_flowsList sub flowsGETGet list of sub flows. Needs an API token with the Manage Flow permission.
Subscriber field, 2 operations
clear_subscriber_user_fieldsClear subscriber user fieldsDELETEClears up to 20 user field values of a subscriber, each identified by var_ns. Needs an API token with the Manage Flow permission.clear_subscriber_user_fields_by_nameClear subscriber user fields by nameDELETEClears up to 20 user field values of a subscriber, each identified by field name. Needs an API token with the Manage Flow permission.
Subscriber label, 2 operations
add_subscriber_labels_by_nameAdd subscriber labels by namePOSTAdd labels by label name to subscriber, up to 20 labels. Needs an API token with the Manage Flow permission.list_subscriber_labelsList subscriber labelsGETLists label assignments on subscribers of the current flow, filtered by subscriber or label; page on with start_id. Needs an API token with the Manage Flow permission.
Ticket comment, 2 operations
add_ticket_commentAdd ticket commentPOSTAdd a comment and optional attachment URL to a ticket. Needs an API token with the Manage Team permission.list_ticket_commentsList ticket commentsGETGet comments and attachment URLs for a ticket. Needs an API token with the Manage Team permission.
Agent, 1 operation
list_flow_agentsList flow agentsGETGet list of agents. Needs an API token with the Manage Flow permission.
Agent activity, 1 operation
list_agent_activity_logList agent activity logGETLists agent and bot activity log entries (open, close, assign, reply, tag and label changes...) for the current flow, filtered by subscriber, agent, action or time; page on with start_id. Needs an API token with the Manage Flow permission.
Agent summary, 1 operation
get_agent_summaryGet agent summaryGETReturns per-agent conversation statistics for a date range (default yesterday), across the workspace bots or for one bot with flow_ns. Needs an API token with the Manage Team permission.
Booking slot, 1 operation
list_booking_available_slotsList booking available slotsGETLists the start times (UTC) of a booking service that still have a free seat between start_time and end_time, within the service's booking window. Needs an API token with the Manage Team permission.
Bot, 1 operation
list_botsList botsGETLists the workspace's bots (flows) with their flow_ns, filterable by name or channel type. Needs an API token with the Manage Team permission.
Conversation, 1 operation
list_conversation_dataList conversation dataGETLists conversation records of the current flow (assignment, reply and close times per conversation); only closed conversations unless status says otherwise. Page on with start_id. Needs an API token with the Manage Flow permission.
Error log, 1 operation
list_error_logsList error logsGETGet error logs for the current flow. Needs an API token with the Manage Flow permission.
Flow summary, 1 operation
get_flow_summaryGet flow summaryGETReturns bot statistics for a date range (default yesterday), across the workspace bots or for one bot with flow_ns. Needs an API token with the Manage Team permission.
Member, 1 operation
list_workspace_membersList workspace membersGETGet list of workspace members. Needs an API token with the Manage Team permission.
Segment, 1 operation
list_segmentsList segmentsGETGet list of segments by flow. Needs an API token with the Manage Flow permission.
Template install, 1 operation
list_template_installsList template installsGETGet list of template installs in this flow. Needs an API token with the Manage Flow permission.
Ticket field, 1 operation
list_ticket_list_fieldsList ticket list fieldsGETLists the fields (columns) of a ticket list. UChat documents only the status field of the response. Needs an API token with the Manage Team permission.
Ticket list, 1 operation
list_ticket_listsList ticket listsGETGet list of ticket lists. Needs an API token with the Manage Team permission.
Ticket log, 1 operation
list_ticket_change_logList ticket change logGETLists the change log of a ticket list (which ticket column changed, when), filtered by time, bot, subscriber, ticket or column. Needs an API token with the Manage Team permission.
User, 1 operation
get_meGet meGETReturns the id, name and email of the UChat user who owns the API token.
Whatsapp call, 1 operation
list_whatsapp_call_logsList whatsapp call logsGETGet paginated WhatsApp call logs for the workspace. Needs an API token with the Manage Team permission.
Workspace, 1 operation
get_workspaceGet workspaceGETReturns the workspace id, name, image and owner. Needs an API token with the Manage Team permission.
Showing the first 120 of 158 endpoints. The rest are in the product, searchable from the workflow builder and from chat.
Use UChat from Claude Code, Cursor or Codex
Connect UChat in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its UChat operations become tools the client can call, next to every other integration you connected.
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"
[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"{
"mcpServers": {
"livecontext": {
"type": "http",
"url": "https://livecontext.ai/mcp",
"headers": {
"X-API-Key": "YOUR_API_KEY"
}
}
}
}How to connect UChat
- Create your workspace
Sign up free. Nothing to install.
- Connect UChat once
Add your UChat connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
- Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.
UChat integration FAQ
What can you do with the UChat integration?
LiveContext exposes 158 operations on UChat, covering subscriber, broadcast, booking and discount code.
