Manage Chat Data chatbots, training, conversations, leads, live chat, WhatsApp messages and analytics.
Explore 32 workflow actions for Chat Data, including account permissions and operation limits.
13 read actions19 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Attach a Lead for Conversation
Write
Attach or update a lead for a specific conversation.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create and train a chatbot
Write
Create a Chatbot using either our medical chat models, custom data upload, or a custom model.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a chatbot
Write
This API enables the deletion of a chatbot by specifying its ID.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a conversation
Write
Deletes a specific conversation associated with a chatbot.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a sub-user
Write
Delete a sub-user from the company.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a webhook from the chatbot
Write
Delete the webhook which has the give url and all event under the webhook.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete an action from a chatbot
Write
Deletes a specific action from the chatbot by either name or index.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete chatbot icon picture
Write
Delete a chatbot icon picture.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete chatbot profile picture
Write
Delete a chatbot profile picture.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete uploaded file
Write
This API endpoint allows you to delete a previously uploaded file associated with a chatbot.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a chatbot
Read
Returns the related information about a single chatbot.
Permissions and limits
Account permissions
A Chat Data API key
Get a conversation
Read
Get detailed information about a specific conversation, including messages, customer details if available, and metadata.
Permissions and limits
Account permissions
A Chat Data API key
Get a specific action for a chatbot
Read
Retrieves a specific action by name or index for the specified chatbot.
Permissions and limits
Account permissions
A Chat Data API key
Get all chatbots
Read
Returns a list of all chatbots under your account with related information.
Permissions and limits
Account permissions
A Chat Data API key
Get Chatbot Status
Read
Get the current training progress of the chatbot.
Permissions and limits
Account permissions
A Chat Data API key
Get conversations
Read
Get conversations from a chatbot.
Permissions and limits
Account permissions
A Chat Data API key
Get Customers
Read
Get collected customers from a chatbot.
Permissions and limits
Account permissions
A Chat Data API key
Get the current plan of the user
Read
Get a summary of the user's current subscriptions and priviledges.
Permissions and limits
Account permissions
A Chat Data API key
Get the statistic distribution of the chatbot
Read
Get the aggregated statistics of a chatbot.
Permissions and limits
Account permissions
A Chat Data API key
List all actions for a chatbot
Read
Retrieves all configured actions for the specified chatbot.
Permissions and limits
Account permissions
A Chat Data API key
List all sub-users
Read
Returns a list of all sub-users belonging to the authenticated user's company.
Permissions and limits
Account permissions
A Chat Data API key
Retrain an existing chatbot
Write
The Chatbot Retrain API enables you to retrain an existing chatbot.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Retrieve confidence score for context chunks
Read
This operation retrieves the confidence scores (defined as cosine similarity) of related chunks used to generate answers.
Permissions and limits
Account permissions
A Chat Data API key
Retrieve context chunks
Read
This operation fetches segments pertinent to generating responses.
Permissions and limits
Account permissions
A Chat Data API key
Send Live Chat Message
Write
Send live chat messages to a chatbot for an existing conversation.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send Outbound WhatsApp Web Message
Write
Initiate an outbound WhatsApp Web message to a phone number, creating a new conversation thread.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Toggle Bot Activation Status
Write
Toggle or set the activation status of a third-party messaging platform integration (WhatsApp, Messenger, or Instagram) for a specific chatbot.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Toggle Bot Control
Write
Toggle the bot control state for a conversation.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Toggle Live Chat State
Write
Toggle the state of a live chat session for a specific conversation.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Analytics Sharing Settings
Write
This API endpoint allows you to configure analytics sharing settings for your chatbot.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Chatbot Settings
Write
This API endpoint allows you to edit your chatbot.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update White Label Settings
Write
This API endpoint allows you to update white label settings for your chatbot.
Permissions and limits
Account permissions
A Chat Data API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Chat Data. A saved workflow is not a completed provider action.