Skip to main content
Chatbotkit logo
  • Category: ai chatbots
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 284
  • Triggers: 0
  • Slug: CHATBOTKIT
  • Version: 20261101_00

Tools

Slug: CHATBOTKIT_ATTACH_DATASET_FILETool to attach a file to a dataset as a source. Use when you need to link a specific file to a dataset to provide knowledge content.

Input Parameters

string ("source")
required
The type of attachment. Must be ‘source’ to indicate the file is a source for the dataset.
string
required
The unique identifier of the file to attach to the dataset.
string
required
The unique identifier of the dataset to attach the file to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_AUTHENTICATE_SECRETTool to authenticate a secret by its ID. Use when you need to generate an authentication URL for a specific secret.

Input Parameters

string
required
The ID of the secret to authenticate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CLONE_BLUEPRINTTool to clone an existing blueprint. Use when you need to create a duplicate of a blueprint with all its associated resources.

Input Parameters

string
required
The unique identifier of the blueprint to clone. Use the List Blueprints action to find available blueprint IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CLONE_BOTTool to clone an existing bot. Use when you need to create a duplicate copy of a bot with all its settings and configurations.

Input Parameters

string
required
The unique identifier of the bot to clone. Use the List Bots action to find available bot IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CLONE_PLATFORM_EXAMPLETool to clone a platform example. Use when you need to create instances of all resources defined in a platform example template.

Input Parameters

string
required
The ID (slug) of the platform example to clone. Use the List Platform Examples action to find available example IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CLONE_WIDGET_INTEGRATIONTool to clone an existing widget integration. Use when you need to duplicate a widget integration while preserving its tested configurations.

Input Parameters

string
required
The unique identifier of the widget integration to clone. Use the List Integrations action to find available widget integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_COMPLETE_CONVERSATIONSend user text to an existing ChatBotKit conversation to generate a bot reply. The action accepts JSON or JSONL response formats and returns the reply along with message and completion information, including token usage.

Input Parameters

string
required
The user’s input message to send to the bot. This is the text the AI will respond to.
string ("application/json" | "application/jsonl")
Response format. Leave empty (default) for standard JSON response. Set to ‘application/jsonl’ for streaming responses with real-time token updates.
string
required
The unique identifier of the conversation to send a message to. Obtain this ID from the list_conversations action or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_BLUEPRINTTool to create a new blueprint in ChatBotKit. Use when you need to create a reusable template or configuration blueprint.

Input Parameters

object
Additional metadata to associate with the blueprint as key-value pairs. Can contain any flexible properties.
string
The associated name for the blueprint. This is the display name that identifies the blueprint.
string
The unique alias for the blueprint instance. Use this to reference the blueprint by a human-readable identifier.
string ("private" | "protected" | "public")
Visibility options for blueprints.
string
The associated description explaining the purpose or contents of this blueprint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_BLUEPRINT_GRAPHQLTool to create a new blueprint template via GraphQL mutation. Use when you need to create a reusable bot configuration template via the GraphQL API.

Input Parameters

object
Additional metadata to associate with the blueprint as key-value pairs. Can contain any flexible properties.
string
required
The display name for the blueprint. This identifies the blueprint template.
string
A unique human-readable identifier for the blueprint. Use this to reference the blueprint by a memorable alias.
string ("private" | "protected" | "public")
Visibility options for blueprints.
string
Description explaining the purpose or contents of this blueprint template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_BOTTool to create a new AI bot with configurable settings. Use when you need to create a new chatbot with specific name, personality, model, and connected resources like datasets or skillsets.

Input Parameters

string
Name for the bot. This is the display name that identifies the bot.
string
Language model to use for the bot (e.g., ‘gpt-4-turbo’, ‘gpt-3.5-turbo’). Determines the AI engine powering the bot’s responses.
string
Background context and personality for the bot. This defines the bot’s character, knowledge, and how it should behave in conversations.
string
ID of the dataset for knowledge retrieval. Connect the bot to a dataset to enable it to answer questions based on specific knowledge.
string
ID of the skillset for abilities. Attach a skillset to provide the bot with specific capabilities or tools.
string
Description of the bot. Explains the purpose or role of this bot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_BOT_GRAPHQLTool to create a new bot using GraphQL mutation. Use when you need to create a bot with specified name, description, and other configuration via the GraphQL API.

Input Parameters

string
Name for the bot. This is the display name that identifies the bot.
string
Language model to use for the bot (e.g., ‘gpt-4-turbo’, ‘gpt-3.5-turbo’). Determines the AI engine powering the bot’s responses.
string
Background context and personality for the bot. This defines the bot’s character, knowledge, and how it should behave in conversations.
string
ID of the dataset for knowledge retrieval. Connect the bot to a dataset to enable it to answer questions based on specific knowledge.
string
ID of the skillset for abilities. Attach a skillset to provide the bot with specific capabilities or tools.
string
Description of the bot. Explains the purpose or role of this bot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_BOT_SESSIONCreates a new bot session with an associated conversation and authentication token. Use this when you need to start a new chat session with a bot, optionally with pre-populated messages.

Input Parameters

object
Optional metadata key-value pairs for organizing or tagging the session.
string
required
The unique identifier of the bot for this session. Use the List Bots action to find available bot IDs.
array
Optional array of messages to pre-populate the conversation. Each message must have a ‘type’ and ‘text’ field.
number
The maximum amount of time (in seconds) this session will stay open. Leave empty for default duration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_CONTACTTool to create a new contact. Use when you need to track users interacting with bots. Contacts can have associated memories, secrets, and conversations.

Input Parameters

object
Custom metadata for the contact. Key-value pairs for storing additional context or tags.
string
Name for the contact. A human-readable identifier for the user interacting with your bot.
string
Nickname for the contact.
string
Email address of the contact.
string
Phone number of the contact.
integer
Timestamp (ms) when the contact was verified.
string
Description of the contact. Additional information about the contact or their role.
string
required
Unique identifier for the contact. Required field.
string
Contact preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_CONVERSATIONTool to create a new conversation. Use when you need to start a new chat session with a bot. Conversations store message history between users and bots. You can either reference an existing bot by ID or configure a new bot inline.

Input Parameters

object
Additional metadata to associate with the conversation as key-value pairs.
string
Name of the conversation for identification and organization purposes.
string
ID of an existing bot to use for this conversation. Use this OR inline bot configuration (model, backstory, etc.), not both.
string
Model definition for inline bot configuration. Specify the AI model to use (e.g., ‘gpt-3.5-turbo’, ‘gpt-4’). Only used if botId is not provided.
string
ID of a task to associate with this conversation.
boolean
Privacy flag. Set to true to enable privacy mode for this conversation.
string
ID of a space to associate with this conversation for organization.
array
Initial messages to seed the conversation with. Each message must have a type and text.
string
Bot backstory for inline bot configuration. Sets the bot’s personality and context. Only used if botId is not provided.
string
ID of a contact to associate with this conversation.
string
ID of a dataset to associate with the conversation for knowledge retrieval.
boolean
Moderation flag. Set to true to enable content moderation for this conversation.
string
ID of a skillset to associate with the conversation for enhanced capabilities.
string
A description explaining the purpose or context of this conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_CONVERSATION_MESSAGETool to create a new message in an existing conversation. Use this to add user messages, bot messages, or other message types to a conversation.

Input Parameters

object
Optional metadata object for storing additional custom information about this message.
string
Optional name associated with this message.
string
required
The text content of the message to create.
string ("user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity")
required
The type of message to create. ‘user’ for user messages, ‘bot’ for bot responses, ‘context’ for contextual information, ‘instruction’ for instructions, ‘backstory’ for background information, ‘reasoning’ for reasoning steps, ‘activity’ for activity logs.
array
Optional array of known entities to associate with this message. Entities are structured data extracted from the message text.
string
Optional description for this message.
string
required
The unique identifier of the conversation to add the message to. Obtain this from list_conversations or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_CONVERSATION_MESSAGE_BATCHTool to create multiple messages in a conversation in a single batch operation. Use this when you need to add multiple messages at once, which is more efficient than creating them individually.

Input Parameters

array
required
Array of message items to create in batch. Each item must have a type and text field.
string
required
The unique identifier of the conversation to add the messages to. Obtain this from list_conversations or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_CONVERSATION_SESSIONTool to create a new conversation session with an authentication token. Use when you need to generate a temporary access token for a conversation.

Input Parameters

string
required
The unique identifier of the conversation. Use the Create Conversation or List Conversations action to find conversation IDs.
number
The maximum amount of time (in seconds) this session will stay open. Leave empty for default duration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_DATASET_GRAPHQLTool to create a new dataset using GraphQL mutation. Use when you need to create a dataset to store knowledge and information for bots.

Input Parameters

object
Custom metadata to associate with the dataset as key-value pairs.
string
Name of the dataset. This is the display name that identifies the dataset.
string
Unique alias identifier for the dataset. Used for programmatic access.
string
The storage backend to use for the dataset (e.g., ‘ada-loom’).
string
The reranker model to use for search results (e.g., ‘bge-v2-m3’).
string
Separators used for chunking text in the dataset.
string
Visibility setting for the dataset. Controls access permissions.
string
ID of the blueprint to associate with this dataset.
string
Description of the dataset’s purpose and contents.
number
Minimum similarity score threshold for search results (0.0 to 1.0).
integer
Maximum number of tokens per record in the dataset.
integer
Maximum number of tokens to return in search results.
string
Instruction to display or apply when a match is found in the dataset.
integer
Maximum number of records to return in search results.
string
Instruction to display or apply when no match is found in the dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_DATASET_RECORDTool to create a new record in a dataset. Use when you need to add text data to an existing dataset for knowledge retrieval by bots.

Input Parameters

object
Optional metadata object for storing additional custom information about this record.
string
required
The text content of the record to create. This is the main data that will be stored in the dataset.
string
Optional source identifier for the record. Use to track where the record originated from.
string
required
The unique identifier of the dataset to add the record to. Obtain this from list_datasets or when creating a dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_DISCORD_INTEGRATIONTool to create a Discord integration for a ChatBotKit bot. Use when you need to connect a bot to Discord by providing Discord Application ID, Bot Token, and Public Key.

Input Parameters

string
required
Discord Application ID from Discord Developer Portal General Information section.
string
required
Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs.
string
Optional slash command handle for the bot (default is /discord).
string
required
Discord Bot Token obtained from Bot section in Discord Developer Portal.
string
required
Discord Public Key from Discord Developer Portal General Information section.
integer
Optional session duration in seconds.
boolean
Optional flag to enable contact collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_EMAIL_INTEGRATIONTool to create a new email integration for a ChatBotKit bot. Email integrations enable your bot to receive and respond to emails, making it accessible through email communication channels. Use when you need to connect a bot to handle email-based conversations.

Input Parameters

string
Name of the email integration. A human-readable identifier for this integration.
string
required
The ID of the bot to associate with this email integration. Use the List Bots action to find available bot IDs.
string
Allowed sender emails for the integration. Comma-separated list of email addresses that are permitted to send emails to this integration.
boolean
Whether to enable attachments for the email integration. When enabled, the bot can receive and process email attachments.
string
The ID of the blueprint to use for this email integration. Blueprints provide template configurations.
string
Description of the email integration. Explains the purpose or function of this integration.
integer
Session duration in seconds. Defines how long a conversation session remains active before timing out.
boolean
Whether to enable contact collection. When enabled, the integration will collect and store contact information from email interactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_EXTRACT_INTEGRATIONTool to create a new Extract integration for a ChatBotKit bot. Extract integrations enable your chatbot to automatically pull and extract structured data from conversations based on a predefined JSON schema. Use when you need to capture specific information from user interactions and optionally send it to a webhook endpoint.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
A human-readable name for the Extract integration.
string
required
The unique identifier of the bot to attach this Extract integration to. Use the List Bots action to find available bot IDs.
string
Optional AI model to use for data extraction. If not specified, uses the default model.
object
required
A JSON schema object defining the structure of data to extract from conversations. Each key is a field name, with ‘type’ and ‘description’ properties defining that field.
string
Optional request configuration for the integration. Can be a simple webhook URL string (e.g. ‘https://example.com/webhook’) or a detailed request configuration object with url, method, headers, etc.
string
Optional ID of the blueprint to associate with this integration.
string
Optional description explaining the purpose of this Extract integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_FILETool to create a new file resource in ChatBotKit. Use when you need to create a file that can be attached to datasets for processing and indexing. Note: This creates the file record; use the upload action to add actual file content.

Input Parameters

object
Custom metadata object for storing additional file-specific information as key-value pairs.
string
A descriptive name for the file. This helps identify the file in listings.
string
Access control setting for the file. Use ‘private’ for restricted access (default) or ‘public’ for publicly accessible files.
string
Associate the file with a blueprint resource. Provide the blueprint ID to link this file.
string
Detailed information about the file’s purpose and contents. Use this to document what the file is for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_INSTAGRAM_INTEGRATIONTool to create an Instagram integration for a ChatBotKit bot. Use when you need to connect a bot to Instagram by providing an Instagram access token.

Input Parameters

object
Optional additional metadata as key-value pairs for organizing or tagging the integration.
string
Optional human-readable name for the Instagram integration.
string
required
The ID of the bot this integration is using. Use the List Bots action to find available bot IDs.
string
required
Instagram access token for authentication. This token is used to authenticate with Instagram’s API.
boolean
Optional flag to enable attachments support in Instagram conversations.
string
Optional ID of the blueprint to use for this integration.
string
Optional description explaining the purpose of this integration.
integer
Optional session duration in seconds. Defines how long a conversation session remains active.
boolean
Optional flag to enable contact collection from Instagram conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_INTEGRATIONCreates a new support integration for a ChatBotKit bot. Support integrations enable your chatbot to handle customer support inquiries and optionally forward conversation summaries to a specified email address. Use this when you need to connect a bot to your customer support workflow.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
required
A human-readable name for the support integration.
string
required
The unique identifier of the bot to attach this support integration to. Use the List Bots action to find available bot IDs.
string
Optional email address where conversation summaries and customer inquiries will be forwarded (e.g., your support team’s inbox).
string
Optional description explaining the purpose of this integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_MCPSERVER_INTEGRATIONTool to create a new MCP Server integration for ChatBotKit. Use when you need to set up an MCP (Model Context Protocol) Server integration to extend bot capabilities with custom server-side functionality.

Input Parameters

object
Optional metadata for the integration. Key-value pairs for organizing or tagging the integration.
string
required
The name of the MCP Server integration. A human-readable identifier for this integration.
string
Optional skillset ID to associate with the integration. Use the List Skillsets action to find available skillset IDs.
string
Optional blueprint ID to associate with the integration. Blueprints provide template configurations.
string
A description of the MCP Server integration. Explains the purpose or function of this integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_MEMORYTool to create a new memory entry. Use when you need to store information for later retrieval, such as user preferences, conversation context, or important facts associated with a bot or contact.

Input Parameters

object
Custom metadata for the memory. Key-value pairs for storing additional context or tags.
string
Name for the memory. A human-readable identifier for this memory entry.
string
required
The text content of the memory. This is the main content that will be stored and recalled later.
string
ID of the bot to associate this memory with. If provided, the memory will be specific to this bot.
string
ID of the contact to associate this memory with. If provided, the memory will be specific to this contact.
string
Description of the memory. Additional context or categorization for the memory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_MESSENGER_INTEGRATIONTool to create a Facebook Messenger integration for a ChatBotKit bot. Use when you need to connect a bot to Facebook Messenger by providing a Facebook Page Access Token.

Input Parameters

object
Optional additional metadata as key-value pairs for organizing or tagging the integration.
string
Optional human-readable name for the Messenger integration.
string
required
Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs.
string
required
Facebook Page Access Token from Facebook Developer Portal. Required for authenticating with Facebook Messenger API.
boolean
Optional flag to enable support for attachments in Messenger conversations.
string
Optional ID of the blueprint to use for this integration.
string
Optional description explaining the purpose of this integration.
integer
Optional session duration in milliseconds. Defines how long a conversation session remains active (default: 24 hours or 86400000 milliseconds).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_NOTION_INTEGRATIONTool to create a Notion integration for a ChatBotKit dataset. Use when you need to connect a dataset to Notion for syncing content between Notion pages and ChatBotKit.

Input Parameters

string
required
The Notion API token for authentication. Obtain this from Notion’s integration settings.
string
required
The dataset ID to connect the Notion integration to. Use the List Datasets action to find available dataset IDs.
integer
Optional record expiration time in milliseconds. Records will be automatically deleted after this duration.
string
Optional description for the integration to help identify its purpose.
string ("never" | "daily" | "weekly" | "monthly")
Sync frequency options for Notion integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_RATINGTool to create a rating in ChatBotKit. Use when you need to submit a numeric rating value for tracking purposes.

Input Parameters

integer
required
The rating value (numeric). Represents the rating score to be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_SECRETTool to create a new secret in ChatBotKit. Secrets store credentials that bots use to access external services via skillset abilities. Use when you need to securely store API keys, tokens, or other authentication credentials.

Input Parameters

string ("shared" | "personal")
required
Storage type: ‘shared’ means platform-stored (accessible across the organization), ‘personal’ means user-stored (accessible only to the user who created it).
string
required
Identifier for the secret. This is the display name that identifies the secret.
string ("plain" | "basic" | "bearer" | "oauth" | "template")
required
Authentication method type: ‘plain’ for plain text, ‘basic’ for HTTP basic auth, ‘bearer’ for bearer tokens, ‘oauth’ for OAuth credentials, or ‘template’ for custom templates.
string
The actual credential data (e.g., API key, token, password). Required for ‘shared’ secrets (will be encrypted at rest). Must NOT be provided for ‘personal’ secrets (user provides at runtime).
string ("private" | "public")
Access control level for the secret
string
Description of the secret. Explains what this secret is used for or which service it authenticates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_SECRET_GRAPHQLTool to create a new secret via GraphQL mutation. Use when you need to securely store credentials, API keys, or authentication tokens via the GraphQL API.

Input Parameters

string ("shared" | "personal")
required
Whether the secret is shared across the organization or personal to the user: ‘shared’ means platform-stored (accessible across the organization), ‘personal’ means user-stored (accessible only to the user who created it).
string
required
A reference identifier for the secret. This is the display name that identifies the secret.
string ("plain" | "basic" | "bearer" | "oauth" | "template")
required
The authentication mechanism for this secret: ‘plain’ for plain text, ‘basic’ for HTTP basic auth, ‘bearer’ for bearer tokens, ‘oauth’ for OAuth credentials, or ‘template’ for custom templates.
string
The actual credential data (e.g., API key, token, password). Required for ‘shared’ secrets, must be omitted for ‘personal’ secrets (user provides at runtime). This will be encrypted at rest by ChatBotKit.
string ("private" | "public")
required
Access control level for the secret: ‘private’ restricts access to the owner, ‘public’ allows broader access within the organization.
string
Optional description for the secret. Explains the purpose or usage of this credential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_SITEMAP_INTEGRATIONTool to create a sitemap integration for a ChatBotKit dataset. Sitemap integrations automatically crawl and index website content from a sitemap.xml file, keeping your dataset synchronized with your website content. Use when you need to import or sync website content into a dataset for bot knowledge.

Input Parameters

string
required
The sitemap URL to integrate. Must be a valid sitemap.xml URL that the system can crawl to extract pages for the dataset.
string
Pattern for filtering URLs from the sitemap. Use glob patterns to include or exclude specific URL patterns (e.g., ‘/blog/**’ to only include blog pages).
string
Name of the sitemap integration. A human-readable identifier for this integration.
string
required
The ID of the dataset to associate with this sitemap integration. Use the List Datasets action to find available dataset IDs.
integer
Expiration time in seconds. Defines how long the integration remains active before expiring.
string
CSS selectors for content extraction. Specify which parts of the page to extract (e.g., ‘article’, ‘.content’, ‘#main’). Leave empty to extract all content.
boolean
Whether to enable JavaScript rendering when crawling pages. Enable this if the website content is dynamically loaded via JavaScript.
string
Description of the sitemap integration. Explains the purpose or function of this integration.
string
Schedule for syncing the sitemap. Defines how frequently the system should re-crawl the sitemap to update the dataset with new or changed content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_SKILLSETTool to create a new skillset. Use when you need to group multiple skills into a single reusable unit.

Input Parameters

object
Additional metadata to associate with the skillset as key-value pairs.
string
required
Name of the skillset. This is the display name that identifies the skillset.
string
Visibility setting for the skillset. Controls who can access this skillset.
string
A description explaining the purpose or contents of this skillset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_SLACK_INTEGRATIONTool to create a Slack integration for a ChatBotKit bot. Use when you need to connect a bot to Slack by providing signing secret and bot token from Slack Developer Portal.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Optional name for the Slack integration.
string
Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs.
boolean
Whether to enable ratings feature allowing users to rate bot responses.
string
The Slack Bot User OAuth Token from OAuth & Permissions page. Required for bot functionality.
string
Slack user token for additional permissions beyond bot token capabilities.
boolean
Whether to enable references feature for providing source citations.
string
Auto-respond configuration for the Slack integration. Determines when the bot responds to messages.
string
Optional description explaining the purpose of this integration.
string
The Slack signing secret from your Slack App’s Basic Information section. Used to verify requests from Slack.
integer
Session duration in seconds. Defines how long a conversation session remains active.
integer
Number of visible messages to display in the conversation history. Maximum value is 10.
boolean
Whether to enable contact collection for tracking user interactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_SPACETool to create a new space in ChatBotKit. Use when you need to create a workspace or organizational container for related resources.

Input Parameters

string
The name of the space. This is the display name that identifies the space.
string
Optional contact ID to associate with the space. Links the space to a specific contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_TASKTool to create a new background task that can be triggered to perform automated operations. Use when you need to set up scheduled or on-demand tasks with configurable bot and contact associations.

Input Parameters

string
Name for the task. This is the display name that identifies the task.
string
Bot ID to associate with this task. The bot will execute the task when triggered.
number
Maximum time allowed for this task execution (in seconds or milliseconds). Prevents tasks from running indefinitely.
string
Schedule for the task using cron expression format (e.g., ‘0 9 * * *’ for 9 AM daily). Defines when the task should run automatically.
string
Contact ID to associate with this task. Links the task to a specific contact.
string
Description of the task. Explains the purpose or what the task will do.
number
Maximum number of iterations allowed for this task execution. Controls how many times the task can loop or retry.
number
Session duration for the task (in seconds). Defines how long the task session should remain active.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_TELEGRAM_INTEGRATIONTool to create a Telegram integration for a ChatBotKit bot. Use when you need to connect a bot to Telegram by providing a Telegram bot token from BotFather.

Input Parameters

string
Optional human-readable name for the Telegram integration.
string
required
Reference to an existing bot ID - must be a valid bot that exists in the account. Use the List Bots action to find available bot IDs.
string
required
The Telegram bot token obtained from BotFather. Required for authenticating with Telegram Bot API.
boolean
Optional flag to enable support for attachments in Telegram conversations.
string
Optional description explaining the purpose of this integration.
integer
Optional session duration in milliseconds. Defines how long a conversation session remains active (default: 24 hours or 86400000 milliseconds).
boolean
Optional flag to enable contact information collection from Telegram users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_TRIGGER_INTEGRATIONTool to create a Trigger integration for a ChatBotKit bot. Use when you need to set up automated triggers that can process events and execute bot actions on a schedule or based on specific conditions.

Input Parameters

string
A descriptive name for the trigger integration.
string
required
The identifier of the bot that will process the trigger events. Use the List Bots action to find available bot IDs.
integer
Maximum time for execution in milliseconds.
string
A description of what the trigger handles.
boolean
Boolean to enable/disable authentication.
integer
Maximum number of iterations.
integer
The duration for sessions in milliseconds.
object
Schedule configuration for the trigger.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_TWILIO_INTEGRATIONTool to create a Twilio integration for a ChatBotKit bot. Use when you need to connect a bot to Twilio for SMS or messaging capabilities. All parameters are optional.

Input Parameters

string
Reference to an existing bot ID. Use the List Bots action to find available bot IDs. Optional: if not provided, a default bot configuration will be used.
integer
Optional session duration in seconds. Defines how long a conversation session remains active before timing out.
boolean
Optional flag to enable contact collection. When enabled, the integration will collect and store contact information from Twilio interactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_WHATS_APP_INTEGRATIONCreates a new WhatsApp integration for a ChatBotKit bot. WhatsApp integrations enable your chatbot to communicate with users through WhatsApp messaging. Use this when you need to connect a bot to WhatsApp Business API for customer engagement.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
required
A human-readable name for the WhatsApp integration.
string
Optional unique identifier of the bot to attach this WhatsApp integration to. Use the List Bots action to find available bot IDs.
string
WhatsApp access token for authenticating API requests to Meta’s WhatsApp Business API.
boolean
Enable support for sending and receiving attachments (images, documents, etc.) through WhatsApp.
string
Optional unique identifier of the blueprint to use for this integration.
string
Optional description explaining the purpose of this integration.
string
WhatsApp phone number ID assigned by Meta for your WhatsApp Business account.
number
Duration in seconds for which a conversation session remains active. After this period, a new session will be created.
boolean
Enable collection of contact information from WhatsApp users during conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_WIDGET_INTEGRATIONTool to create a Widget integration for a ChatBotKit bot. Use when you need to create a web widget that can be embedded on websites to enable conversations with a bot.

Input Parameters

boolean
Enable form functionality in the widget.
boolean
Enable mathematical notation rendering in the widget.
string
required
The unique identifier of the bot to associate with this widget integration. Use the List Bots action to find available bot IDs.
string
Introduction text to display in the widget.
string
Theme for the widget appearance.
string
Title to display in the widget header.
boolean
Enable tools functionality in the widget.
string
Layout style for the widget.
string
Origin URL where the widget is allowed to be embedded.
boolean
Enable streaming responses in the widget.
boolean
Enable link unfurling in messages.
string
Initial message to display when the widget loads.
string
Plugins configuration for the widget.
boolean
Enable verbose mode for detailed logging.
boolean
Enable voice input in the widget.
Enable carousel display for messages in the widget.
string
Language code for the widget interface.
boolean
Start the widget in maximized mode.
boolean
Enable voice output in the widget.
boolean
Display ‘Powered by ChatBotKit’ branding in the widget.
boolean
Enable auto-scrolling to the latest message in the widget.
boolean
Start the conversation immediately when the widget loads.
boolean
Enable file attachments in the widget.
boolean
Enable message peek functionality.
string
Placeholder text for the message input field.
number
Session duration in seconds.
boolean
Enable collection of contact information from users.
boolean
Enable users to export their conversation history.
boolean
Enable users to restart the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_CREATE_WIDGET_INTEGRATION_SESSIONCreates a new widget integration session for interactive chat. Use this when you need to initialize a widget chat session with optional contact information, initial messages, and custom session duration.

Input Parameters

object
Custom metadata key-value pairs for tracking and analytics purposes
object
Contact information for a widget session user.
array
Array of initial user messages to seed the conversation (only ‘user’ type messages allowed)
integer
Session validity duration in seconds. Must be between 1,800 and 86,400 seconds. Defaults to widget’s configured duration if not specified.
string
required
The ID of the widget integration. Use the List Widget Integrations action to find available widget integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_BLUEPRINTTool to permanently delete a blueprint from ChatBotKit. Use when you need to remove a blueprint and optionally its associated resources.

Input Parameters

string
required
The unique identifier of the blueprint to delete. This is the ID of the blueprint you want to remove.
boolean
If true, deletes all resources associated with the blueprint. If false or omitted, only the blueprint itself is deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_BLUEPRINT_GRAPHQLTool to permanently delete a blueprint template via GraphQL mutation. Use when you need to remove a blueprint from the platform using the GraphQL API.

Input Parameters

string
required
The unique identifier of the blueprint to delete. This is the ID of the blueprint template you want to permanently remove from the platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_BOTTool to delete a bot. Use when you need to permanently remove a bot from the system.

Input Parameters

string
required
The ID of the bot to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_BOT_GRAPHQLTool to delete a bot via GraphQL mutation. Use when you need to permanently remove a bot from the system using the GraphQL API.

Input Parameters

string
required
The ID of the bot to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_CONTACTTool to permanently delete a contact from ChatBotKit. Use when you need to remove a contact from the system.

Input Parameters

string
required
The unique identifier of the contact to delete. Obtain this ID from the list_contacts action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_CONVERSATIONTool to permanently delete a conversation from ChatBotKit. Use when you need to remove a conversation and all its associated messages.

Input Parameters

string
required
The unique identifier of the conversation to delete. Obtain this ID from the list_conversations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_CONVERSATION_MESSAGETool to permanently delete a message from a conversation in ChatBotKit. Use when you need to remove a specific message from a conversation.

Input Parameters

string
required
The unique identifier of the message to delete. Obtain this from list_conversation_messages.
string
required
The unique identifier of the conversation containing the message. Obtain this from list_conversations or when creating a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_DATASETTool to permanently delete a dataset from ChatBotKit. Use when you need to remove a dataset and all its associated data.

Input Parameters

string
required
The unique identifier of the dataset to delete. Obtain this ID from the list_datasets action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_DATASET_GRAPHQLTool to delete a dataset via GraphQL mutation. Use when you need to permanently remove a dataset and all its associated records using the GraphQL API.

Input Parameters

string
required
The ID of the dataset to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_DATASET_RECORDTool to permanently delete a record from a dataset. Use when you need to remove a specific record from a ChatBotKit dataset.

Input Parameters

string
required
The unique identifier of the record to delete from the dataset.
string
required
The unique identifier of the dataset containing the record. Obtain this ID from the list_datasets action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_DISCORD_INTEGRATIONTool to delete a Discord integration. Use when you need to permanently remove a Discord integration from the system.

Input Parameters

string
required
The ID of the Discord integration to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_EMAIL_INTEGRATIONTool to permanently delete an Email integration from ChatBotKit. Use when you need to remove an Email integration from the system.

Input Parameters

string
required
The unique identifier of the Email integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_EXTRACT_INTEGRATIONTool to delete an Extract integration. Use when you need to permanently remove an Extract integration from the system.

Input Parameters

string
required
The ID of the Extract integration to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_FILETool to permanently delete a file from ChatBotKit. Use when you need to remove a file from the system.

Input Parameters

string
required
The unique identifier of the file to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_INSTAGRAM_INTEGRATIONTool to permanently delete an Instagram integration from ChatBotKit. Use when you need to remove an Instagram integration from the system.

Input Parameters

string
required
The unique identifier of the Instagram integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_INTEGRATION_GRAPHQLTool to delete an integration via GraphQL mutation. Use when you need to permanently remove an integration from the system using the GraphQL API.

Input Parameters

string
required
The unique identifier of the integration to delete. Obtain this ID from the list_integrations action.
string ("email" | "slack" | "discord" | "notion" | "twilio" | "messenger" | "telegram" | "whatsapp" | "instagram" | "sitemap" | "trigger" | "extract" | "mcpserver")
required
The type of integration to delete (e.g., email, slack, discord, notion, twilio, messenger, telegram, whatsapp, instagram, sitemap, trigger, extract, mcpserver)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_MCP_SERVER_INTEGRATIONTool to delete an MCP Server integration. Use when you need to permanently remove an MCP Server integration from the system.

Input Parameters

string
required
The ID of the MCP Server integration to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_MEMORYTool to permanently delete a memory from ChatBotKit. Use when you need to remove a memory from the system.

Input Parameters

string
required
The unique identifier of the memory to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_MESSENGER_INTEGRATIONTool to permanently delete a Messenger integration from ChatBotKit. Use when you need to remove a Messenger integration from the system.

Input Parameters

string
required
The unique identifier of the Messenger integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_NOTION_INTEGRATIONTool to permanently delete a Notion integration from ChatBotKit. Use when you need to remove a Notion integration from the system.

Input Parameters

string
required
The unique identifier of the Notion integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_PARTNER_USERTool to permanently delete a partner user account. Use when you need to clean up test or inactive accounts.

Input Parameters

string
required
The unique identifier of the partner user to delete. This permanently removes the user account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_RATINGTool to permanently delete a rating from ChatBotKit. Use when you need to remove a rating from the system.

Input Parameters

string
required
The unique identifier of the rating to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_SECRETTool to permanently delete a secret from ChatBotKit. Use when you need to remove a secret from the system.

Input Parameters

string
required
The unique identifier of the secret to delete. This ID can be obtained from secret-related actions like listing secrets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_SITEMAP_INTEGRATIONTool to permanently delete a Sitemap integration from ChatBotKit. Use when you need to remove a Sitemap integration from the system.

Input Parameters

string
required
The unique identifier of the Sitemap integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_SKILLSETTool to delete a skillset. Use when you need to permanently remove a skillset from the system.

Input Parameters

string
required
The ID of the skillset to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_SKILLSET_ABILITYTool to delete an ability from a skillset. Use when you need to remove a specific ability from a skillset.

Input Parameters

string
required
The ID of the ability to delete from the skillset
string
required
The ID of the skillset containing the ability to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_SLACK_INTEGRATIONTool to delete a Slack integration. Use when you need to permanently remove a Slack integration from the system.

Input Parameters

string
required
The ID of the Slack integration to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_SPACETool to permanently delete a space from ChatBotKit. Use when you need to remove a space from the system.

Input Parameters

string
required
The ID of the space to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_SUPPORT_INTEGRATIONTool to delete a Support integration. Use when you need to permanently remove a Support integration from the system.

Input Parameters

string
required
The ID of the Support integration to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_TASKTool to permanently delete a task from ChatBotKit. Use when you need to remove a task from the system.

Input Parameters

string
required
The unique identifier of the task to delete. Obtain this ID from the list_tasks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_TELEGRAM_INTEGRATIONTool to permanently delete a Telegram integration from ChatBotKit. Use when you need to remove a Telegram integration from the system.

Input Parameters

string
required
The unique identifier of the Telegram integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_TRIGGER_INTEGRATIONTool to permanently delete a Trigger integration from ChatBotKit. Use when you need to remove a Trigger integration from the system.

Input Parameters

string
required
The ID of the Trigger integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_TWILIO_INTEGRATIONTool to delete a Twilio integration. Use when you need to permanently remove a Twilio integration from the system.

Input Parameters

string
required
The ID of the Twilio integration to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_WHATS_APP_INTEGRATIONTool to permanently delete a WhatsApp integration from ChatBotKit. Use when you need to remove a WhatsApp integration from the system.

Input Parameters

string
required
The unique identifier of the WhatsApp integration to delete. Obtain this ID from the list_integrations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DELETE_WIDGET_INTEGRATIONTool to delete a Widget integration. Use when you need to permanently remove a Widget integration from the system.

Input Parameters

string
required
The ID of the Widget integration to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DETACH_DATASET_FILETool to detach a file from a dataset. Use when you need to remove a file’s association with a dataset, optionally deleting its records.

Input Parameters

string
required
The ID of the file to detach from the dataset
string
required
The ID of the dataset from which to detach the file
boolean
Delete records associated with the file. When true, all records created from this file will be removed from the dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DOWNLOAD_FILETool to download a file by its ID. Use when you need to retrieve a file’s content from ChatBotKit.

Input Parameters

string
required
The ID of the file to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DOWNVOTE_BOTTool to downvote a bot in ChatBotKit. Use when you need to register negative feedback on a bot’s performance or quality.

Input Parameters

string
required
The unique identifier of the bot to downvote. Obtain this ID from the list_bots action.
integer
The value of the downvote. Must be between -100 and -1 (inclusive). Defaults to -100 if not specified.
string
The reason for the downvote. Provides context for why the bot is being downvoted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DOWNVOTE_CONVERSATIONTool to downvote a conversation in ChatBotKit. Use when you need to register negative feedback on a conversation’s quality or outcome.

Input Parameters

integer
The value of the downvote. Must be between -100 and -1 (inclusive). Defaults to -100 if not specified.
string
The reason for the downvote. Provides context for why the conversation is being downvoted.
string
required
The unique identifier of the conversation to downvote. Obtain this from list_conversations or when creating a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_DOWNVOTE_CONVERSATION_MESSAGETool to downvote a conversation message in ChatBotKit. Use when you need to register negative feedback on a message’s quality or appropriateness.

Input Parameters

integer
The value of the downvote. Must be between -100 and -1 (inclusive). Defaults to -100 if not specified.
string
The reason for the downvote. Provides context for why the message is being downvoted.
string
required
The unique identifier of the message to downvote. Obtain this from list_conversation_messages or when creating a message.
string
required
The unique identifier of the conversation containing the message. Obtain this from list_conversations or when creating a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_ENSURE_CONTACTTool to ensure a contact exists or create a new one. Use when you need to create or retrieve a contact by fingerprint, ensuring idempotent contact management.

Input Parameters

string
Optional nickname or display name for the contact.
string
Optional email address for the contact.
string
Optional phone number for the contact.
integer
Optional Unix timestamp (in milliseconds) indicating when the contact was verified.
string
required
Unique identifier or fingerprint for the contact. This is used to identify and retrieve existing contacts or create new ones if they don’t exist.
string
Optional JSON string containing user preferences and settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXECUTE_GRAPHQL_QUERYTool to execute a GraphQL query or mutation against the ChatBotKit API. Use when you need to run custom GraphQL queries to retrieve or modify data in flexible ways not covered by other actions.

Input Parameters

string
required
The GraphQL query or mutation string to execute. Must be a valid GraphQL syntax.
object
Variables for the GraphQL operation. Provide key-value pairs where keys match variable names in the query.
string
The name of the operation to execute. Required only if the query contains multiple operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_CONTACTSTool to export contacts with pagination support. Use when you need to retrieve or export contact information from ChatBotKit.

Input Parameters

object
Key-value pairs to filter contacts by metadata. Only contacts matching all specified metadata key-value pairs will be returned.
integer
Maximum number of contacts to return per page.
string ("asc" | "desc")
Order type for pagination.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_CONVERSATIONSTool to export conversations with pagination support. Use when you need to retrieve and export conversation data in bulk for analysis, backup, or migration purposes.

Input Parameters

object
Key-value pairs to filter conversations by metadata. Only conversations matching all specified metadata fields will be returned.
integer
Number of items to retrieve per page. Must be at least 1.
string ("asc" | "desc")
Sort order of returned items. ‘desc’ returns newest first (default), ‘asc’ returns oldest first.
string
Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_DATASET_RECORDSTool to export dataset records with pagination support. Use when you need to retrieve or export record data from a specific ChatBotKit dataset.

Input Parameters

integer
Maximum number of records to return per page.
string ("asc" | "desc")
Order type for pagination.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.
string
required
The unique identifier of the dataset to export records from. Obtain this from list_datasets or when creating a dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_EVENT_LOGSTool to export event logs with pagination support. Use when you need to retrieve and export event log data for monitoring, auditing, or analysis purposes.

Input Parameters

object
Key-value pairs to filter event logs by metadata. Only event logs matching all specified metadata fields will be returned.
integer
Number of items to retrieve per page. Must be at least 1.
string ("asc" | "desc")
Sort order for pagination.
string
Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_MEMORIESTool to export memories with pagination support. Use when you need to retrieve or export memory information from ChatBotKit.

Input Parameters

object
Key-value pairs to filter memories by metadata. Only memories matching all specified metadata key-value pairs will be returned.
integer
Maximum number of memories to return per page.
string ("asc" | "desc")
Order type for pagination.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_SKILLSET_ABILITIESExport a page of abilities from a specific skillset, with cursor pagination. Missing items or cursor fields in the response are returned as an empty list or empty cursor.

Input Parameters

integer
The number of items to retrieve per page
string ("asc" | "desc")
Order enum for pagination
string
Cursor for pagination. Use the cursor value from a previous response to fetch the next page.
string
required
The ID of the skillset to export abilities from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_SPACESTool to export spaces with pagination support. Use when you need to retrieve or export space data in bulk for analysis, backup, or migration purposes.

Input Parameters

object
Key-value pairs to filter spaces by metadata. Only spaces matching all specified metadata key-value pairs will be returned.
integer
Maximum number of spaces to return per page. Must be at least 1.
string ("asc" | "desc")
Order type for pagination.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_EXPORT_TASKSTool to export tasks with pagination support. Use when you need to retrieve and export task data in bulk for analysis, backup, or migration purposes.

Input Parameters

object
Key-value pairs to filter tasks by metadata. Only tasks matching all specified metadata fields will be returned.
integer
Number of task items to retrieve per page. Must be at least 1.
string ("asc" | "desc")
Sort order for paginated items.
string
Pagination cursor to retrieve the next page of results. Pass the cursor value from the previous response to continue pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_BLUEPRINTTool to fetch a blueprint by ID. Use when you need to retrieve detailed information about a specific blueprint.

Input Parameters

string
required
The ID of the blueprint to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_BLUEPRINT_GRAPHQLFetch a blueprint by ID using GraphQL, returning selected blueprint details in an edges/node response.

Input Parameters

string
required
The unique identifier of the blueprint to retrieve. Use this to fetch detailed blueprint information via GraphQL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_BOTTool to fetch a specific bot by its ID. Use when you need detailed information about a particular bot including configuration, model, dataset, and skillset associations.

Input Parameters

string
required
The ID of the bot to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_BOT_GRAPHQLQuery a bot by ID via GraphQL, returning its ID, name, backstory, and model in a bots connection.

Input Parameters

string
required
The ID of the bot to retrieve. This is the unique identifier for the bot you want to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_BOT_USAGETool to fetch bot usage statistics for a specific bot. Use when you need to retrieve metrics like conversations, messages, and token usage for a given time period.

Input Parameters

string
required
The ID of the bot to retrieve usage statistics for
string
End date for the period in ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’). If not specified, usage up to the current time will be included.
string
Start date for the period in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). If not specified, usage from the beginning will be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_CONTACTTool to retrieve detailed information about a specific contact by ID. Use when you need to access contact details including email, phone, fingerprint, and preferences.

Input Parameters

string
required
Unique identifier of the contact to retrieve. This ID can be obtained from contact listing or creation operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_CONVERSATIONTool to retrieve full details of a specific conversation by its ID. Use when you need complete information about a conversation including its configuration, metadata, and associated resources.

Input Parameters

string
required
The unique identifier of the conversation to retrieve. Obtain this ID from the list_conversations action or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_CONVERSATION_MESSAGETool to retrieve full details of a specific message within a conversation. Use when you need complete information about a particular message including its content, type, and metadata.

Input Parameters

string
required
The unique identifier of the message to retrieve. Obtain this ID from the list_conversation_messages action or when creating a new message.
string
required
The unique identifier of the conversation containing the message. Obtain this ID from the list_conversations action or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_CONVERSATION_USAGETool to fetch usage statistics for a specific conversation. Use when you need to retrieve token and message counts for billing, monitoring, or analytics purposes.

Input Parameters

string
End date for the usage period in ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’). If not provided, fetches usage up to the current time.
string
Start date for the usage period in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). If not provided, fetches usage from the beginning of the conversation.
string
required
The unique identifier of the conversation to fetch usage statistics for. Obtain this ID from the list_conversations action or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_CONVERSATION_WITH_MESSAGES_GRAPHQLFetch a conversation by ID with metadata and a page of messages using GraphQL. The response can include associated bot, contact, space and task information; use message cursors to retrieve subsequent pages.

Input Parameters

string
Cursor for forward pagination. Pass the endCursor from a previous response’s messages pageInfo to get the next page of messages.
integer
Number of messages to retrieve. Use for forward pagination through messages.
string
required
The unique identifier of the conversation to retrieve. Use this to fetch detailed conversation information including all messages via GraphQL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_DATASETTool to fetch a specific dataset by its ID. Use when you need detailed information about a particular dataset including configuration, storage, search settings, and content instructions.

Input Parameters

string
required
The ID of the dataset to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_DATASET_GRAPHQLTool to fetch a single dataset by ID using GraphQL. Use when you need to retrieve dataset details (name, description, timestamps) via the GraphQL endpoint.

Input Parameters

string
required
The unique identifier of the dataset to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_DATASET_RECORDTool to fetch a specific record from a dataset by its ID. Use when you need to retrieve detailed information about a particular dataset record including its text content, source, and metadata.

Input Parameters

string
required
The unique identifier of the record to retrieve from the dataset.
string
required
The unique identifier of the dataset containing the record. Obtain this from list_datasets or when creating a dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_DISCORD_INTEGRATIONTool to fetch a specific Discord integration by its ID. Use when you need detailed information about a particular Discord integration including configuration, bot association, and metadata.

Input Parameters

string
required
The ID of the Discord integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_EMAIL_INTEGRATIONTool to fetch a specific Email integration by its ID. Use when you need detailed information about a particular Email integration including configuration, bot association, and settings.

Input Parameters

string
required
The ID of the Email integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_EXTRACT_INTEGRATIONTool to fetch a specific Extract integration by its ID. Use when you need detailed information about a particular Extract integration including configuration, bot association, request template, and extraction schema.

Input Parameters

string
required
The ID of the Extract integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_FILETool to retrieve detailed metadata about a specific file by its ID. Use when you need file information including name, type, size, and visibility settings. Note: This returns file metadata, not the actual file content.

Input Parameters

string
required
The unique identifier of the file to retrieve. This ID can be obtained from file listing or creation operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_FILE_GRAPHQLTool to fetch a single file by ID using GraphQL. Returns detailed file information including name, description, timestamps, and metadata. Use when you need structured GraphQL response format.

Input Parameters

string
required
The unique identifier of the file to retrieve. Use this to fetch detailed file information via GraphQL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_INSTAGRAM_INTEGRATIONTool to fetch a specific Instagram integration by its ID. Use when you need detailed information about a particular Instagram integration including access token, configuration, and metadata.

Input Parameters

string
required
The ID of the Instagram integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_MCPSERVER_INTEGRATIONTool to fetch a specific MCP Server integration by its ID. Use when you need detailed information about a particular MCP Server integration including configuration, skillset, and blueprint associations.

Input Parameters

string
required
The ID of the MCP Server integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_MEMORYRetrieve a specific memory by ID, including its text, timestamps, and bot or contact associations when available.

Input Parameters

string
required
The ID of the memory to retrieve. This ID can be obtained from memory listing operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_MESSENGER_INTEGRATIONTool to fetch a specific Messenger integration by its ID. Use when you need detailed information about a particular Messenger integration including configuration, bot association, and settings.

Input Parameters

string
required
The ID of the Messenger integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_NOTION_INTEGRATIONTool to fetch a specific Notion integration by its ID. Use when you need detailed information about a particular Notion integration including dataset association, sync status, and metadata.

Input Parameters

string
required
The ID of the Notion integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_PLATFORM_DOCTool to fetch a specific platform documentation by its ID. Use when you need to retrieve documentation content for ChatBotKit platform features.

Input Parameters

string
required
The ID of the documentation to retrieve (e.g., ‘datasets’, ‘skillsets’, ‘bots’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_PLATFORM_EXAMPLETool to fetch a specific platform example with full configuration details by its ID. Use when you need to retrieve complete information about a ChatBotKit example including its type, config, and associated metadata.

Input Parameters

string
required
The ID (slug) of the example to retrieve (e.g., ‘liquid-glass’, ‘customer-support’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_PLATFORM_MANUALTool to fetch a specific platform manual by its ID. Use when you need documentation or help content for a particular platform feature or resource type (e.g., datasets, skillsets, bots).

Input Parameters

string
required
The ID of the manual to fetch (e.g., ‘datasets’, ‘skillsets’, ‘bots’, ‘conversations’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_PLATFORM_MANUALS_GRAPHQLTool to fetch platform manuals using GraphQL query by search query or specific IDs. Use when you need to retrieve documentation manuals for ChatBotKit platform features via GraphQL.

Input Parameters

integer
Number of results to return. Limits the response size.
Search query to find relevant manuals. Leave empty to fetch all manuals.
array
Array of specific manual IDs to fetch. If provided, returns only these manuals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_PLATFORM_TUTORIALTool to fetch a specific platform tutorial by its ID. Use when you need to retrieve tutorial content for ChatBotKit platform features.

Input Parameters

string
required
The ID of the tutorial to fetch (e.g., ‘how-to-get-started-with-chatbotkit’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_PLATFORM_TUTORIALSTool to fetch platform tutorials by search query or IDs. Use when you need to search for tutorials or retrieve specific tutorials to help with ChatBotKit platform features.

Input Parameters

integer
Number of results to return. Limits the number of tutorial results.
string
Search query to find relevant tutorials. Filters tutorials by title, content, or related keywords.
array
Array of specific tutorial IDs to fetch. Use to retrieve particular tutorials by their IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_RATINGTool to retrieve detailed information about a specific rating by ID. Use when you need to access rating details including value, reason, and associated entities.

Input Parameters

string
required
The unique identifier of the rating to fetch. This ID can be obtained from rating listing or creation operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SECRETTool to fetch a secret by ID. Use when you need to retrieve detailed information about a specific secret.

Input Parameters

string
required
The ID of the secret to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SITEMAP_INTEGRATIONTool to fetch a specific Sitemap integration by its ID. Use when you need detailed information about a particular Sitemap integration including configuration, dataset association, URL patterns, and synchronization settings.

Input Parameters

string
required
The ID of the Sitemap integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SKILLSETTool to fetch a specific skillset by its ID. Use when you need detailed information about a particular skillset.

Input Parameters

string
required
The ID of the skillset to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SKILLSET_ABILITYTool to fetch detailed information about a specific ability from a skillset. Use when you need to retrieve ability configuration, instructions, and associated resources.

Input Parameters

string
required
The ID of the ability to retrieve
string
required
The ID of the skillset containing the ability

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SKILLSET_GRAPHQLTool to fetch a single skillset by ID using GraphQL. Use when you need to retrieve skillset details via the GraphQL API.

Input Parameters

string
required
The ID of the skillset to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SLACK_INTEGRATIONTool to fetch a specific Slack integration by its ID. Use when you need detailed information about a particular Slack integration including configuration, bot association, and metadata.

Input Parameters

string
required
The ID of the Slack integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SPACETool to retrieve detailed information about a specific space by ID. Use when you need to access space details including name, description, blueprint, and associated contact.

Input Parameters

string
required
The ID of the space to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_SUPPORT_INTEGRATIONTool to fetch a specific Support integration by its ID. Use when you need detailed information about a particular Support integration including configuration, bot association, and metadata.

Input Parameters

string
required
The ID of the Support integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_TASKTool to retrieve details of a specific task by its ID. Use when you need to check the status, outcome, or configuration of a particular task.

Input Parameters

string
required
The unique identifier of the task to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_TELEGRAM_INTEGRATIONTool to fetch a specific Telegram integration by its ID. Use when you need detailed information about a particular Telegram integration including configuration, bot association, and metadata.

Input Parameters

string
required
The ID of the Telegram integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_TRIGGER_INTEGRATIONTool to fetch a specific trigger integration by its ID. Use when you need detailed information about a particular trigger integration including configuration, schedule, authentication, and associated bot.

Input Parameters

string
required
The ID of the Trigger integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_TWILIO_INTEGRATIONTool to fetch a specific Twilio integration by its ID. Use when you need detailed information about a particular Twilio integration including configuration, bot association, and metadata.

Input Parameters

string
required
The ID of the Twilio integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_USAGETool to fetch account-wide usage statistics including tokens, conversations, messages, and database resources. Use when you need overall usage metrics for billing, monitoring, or analytics purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_USAGE_SERIESTool to fetch usage series data for the last 90 days. Use when you need to analyze token usage, conversation counts, or message counts over time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_WHATSAPP_INTEGRATIONTool to fetch a specific WhatsApp integration by its ID. Use when you need detailed information about a particular WhatsApp integration including configuration, bot association, and settings.

Input Parameters

string
required
The ID of the WhatsApp integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_FETCH_WIDGET_INTEGRATIONTool to fetch a specific Widget integration by its ID. Use when you need detailed information about a particular Widget integration including configuration, bot association, and widget settings.

Input Parameters

string
required
The ID of the Widget integration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_GENERATE_REPORTTool to generate a specific report with time-series breakdowns. Use when you need usage statistics, event metrics, or analytics data for a specific time period.

Input Parameters

string
required
The unique identifier of the report type to generate
integer
Number of days for the report period. Determines the time range for the report data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_GENERATE_REPORTSTool to generate multiple reports simultaneously. Use when you need to retrieve analytics, metrics, or statistical data from ChatBotKit. Report IDs can be obtained from the platform report list endpoint.

Input Parameters

object
required
Map of report IDs to their input parameters. Keys are report IDs (obtained from GET /v1/platform/report/list endpoint), values are objects containing report-specific parameters. Empty objects {} can be used for default parameters. Example: {‘clr3m5n8k000008jq7h9e5b1a’: {}, ‘clr3m5n8k000508jq2j9k0l6f’: {}} for Total Ratings Report and Total Conversations Report with default parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_GET_AUDIT_LOG_EXPORTTool to export audit log entries showing user actions and system events. Use when you need to retrieve audit records for monitoring, compliance, or security analysis.

Input Parameters

integer
Number of items to retrieve per page. Must be at least 1.
string ("asc" | "desc")
Sort order for pagination.
string
Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_GET_EVENT_METRIC_SERIESTool to fetch event metric time series data for a specific metric type. Use when you need to retrieve historical metric data points for analytics, monitoring, or reporting purposes.

Input Parameters

string
required
The type of event metric to fetch (e.g., ‘conversation’). Specifies which metric category to retrieve time series data for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_GET_RATING_EXPORTTool to export ratings with pagination support. Use when you need to retrieve and export rating data in bulk for analysis, backup, or migration purposes.

Input Parameters

object
Key-value pairs to filter ratings by metadata. Only ratings matching all specified metadata fields will be returned.
integer
Number of items to retrieve per page. Must be at least 1.
string ("asc" | "desc")
Order type for pagination.
string
Pagination cursor for fetching the next page of results. Pass the cursor value from the previous response to continue pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_GET_RATING_LISTTool to retrieve a paginated list of ratings. Use when you need to browse, filter, or analyze ratings data.

Input Parameters

object
Key-value pairs to filter ratings by metadata. Only ratings matching all specified metadata pairs will be returned.
integer
Maximum number of ratings to return per page. Must be at least 1.
string ("asc" | "desc")
Sort order of returned items: ‘asc’ for ascending or ‘desc’ for descending. Defaults to ‘desc’.
string
Pagination cursor (rating ID). Pass the ID of the last rating from the previous page to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_INVOKE_TRIGGER_INTEGRATIONTool to invoke a trigger integration in ChatBotKit. Use when you need to manually trigger a specific trigger integration.

Input Parameters

string
required
The ID of the Trigger integration to invoke. Use the List Integrations action to find available trigger integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_AUDIT_LOGSTool to retrieve a paginated list of audit logs. Use when you need to review system activity, security events, or compliance tracking.

Input Parameters

integer
Maximum number of audit log entries to return per page. Must be at least 1.
string
Pagination cursor. Corresponds to the ID of the last resource from the previous list. Pass this to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_BLUEPRINT_RESOURCESTool to list the resources of a blueprint. Use when you need to retrieve all resources associated with a specific blueprint.

Input Parameters

string
required
The ID of the blueprint whose resources should be listed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_BLUEPRINTSTool to retrieve a list of blueprints. Use when you need to browse or paginate through available blueprint templates.

Input Parameters

object
Key-value pairs to filter blueprints by metadata.
integer
Number of blueprints to retrieve per request.
string ("asc" | "desc")
Sort order of returned items: ‘asc’ for ascending or ‘desc’ for descending.
string
Cursor for pagination. Pass the ID of the last blueprint from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_BLUEPRINTS_GRAPHQLTool to list all blueprints using GraphQL with cursor-based pagination. Use when you need to browse blueprint templates via GraphQL endpoint with edges/node connection pattern.

Input Parameters

integer
Number of blueprints to retrieve (backward pagination). Use with ‘before’ cursor.
string
Cursor for forward pagination. Pass the endCursor from pageInfo to get the next page.
integer
Number of blueprints to retrieve (forward pagination). Use with ‘after’ cursor.
string
Cursor for backward pagination. Pass the startCursor from pageInfo to get the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_BOTSTool to retrieve a paginated list of all bots. Use when you need to browse or manage multiple bots, and iterate pages via cursor.

Input Parameters

integer
Maximum number of bots to return per page. Defaults to all bots if not specified.
string
Pagination cursor (bot ID). Pass the ID of the last bot from the previous page to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_BOTS_GRAPHQLTool to query bots via GraphQL with pagination support. Use when you need to retrieve a list of bots using the GraphQL API.

Input Parameters

string
Cursor for forward pagination. Pass the endCursor from a previous response’s pageInfo to get the next page.
integer
Number of bots to retrieve from the beginning of the list. Use for forward pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACT_CONVERSATIONSTool to retrieve a paginated list of conversations for a specific contact. Use when you need to view all conversations associated with a contact.

Input Parameters

integer
Number of items to retrieve per page; must be at least 1.
string ("asc" | "desc")
Sort order of returned items: ‘asc’ for ascending or ‘desc’ for descending. Default is ‘desc’.
string
Pagination cursor to retrieve the next page of results. Use the cursor from a previous response to paginate.
string
required
The unique identifier of the contact whose conversations are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACT_MEMORIESTool to retrieve a paginated list of memories for a specific contact. Use when you need to browse or access memory entries associated with a contact.

Input Parameters

integer
Number of memory items to retrieve; must be at least 1.
string ("asc" | "desc")
Order for pagination
string
Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate.
string
required
Unique identifier of the contact whose memories are to be listed. The contact ID can be obtained from contact-related actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACT_RATINGSTool to retrieve ratings submitted by a specific contact. Use when you need to monitor conversation quality, identify areas for improvement, and track user satisfaction with AI-generated responses.

Input Parameters

object
Filter ratings by metadata. Provide key-value pairs to match against rating metadata.
integer
Number of items to return per request. Must be at least 1.
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending by creation date
string
Pagination cursor from previous response. Pass to get the next page of results.
string
required
The contact ID to retrieve ratings for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACTSTool to retrieve a paginated list of contacts. Contacts represent users interacting with bots. Use when you need to browse, filter, or manage multiple contacts.

Input Parameters

object
Key-value pairs to filter contacts by metadata. Only contacts matching all specified metadata pairs will be returned.
integer
Maximum number of contacts to return per page. Must be at least 1.
string ("asc" | "desc")
Sort order of returned items: ‘asc’ for ascending or ‘desc’ for descending.
string
Pagination cursor (contact ID). Pass the ID of the last contact from the previous page to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACT_SECRETSTool to retrieve a paginated list of secrets for a specific contact. Use when you need to browse or access secret entries associated with a contact.

Input Parameters

integer
Number of secret items to retrieve per page; must be at least 1.
string ("asc" | "desc")
Order for pagination
string
Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate.
string
required
Unique identifier of the contact whose secrets are to be listed. The contact ID can be obtained from contact-related actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACT_SPACESTool to retrieve a paginated list of spaces for a specific contact. Use when you need to fetch all spaces associated with a particular contact ID.

Input Parameters

integer
Number of items to retrieve per page; must be at least 1.
string ("asc" | "desc")
Enum for sort order of returned items.
string
Pagination cursor for fetching the next page of results. Pass the cursor value from a previous response to get the next page.
string
required
The ID of the contact to list spaces for. This is the unique identifier of the contact whose spaces you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACTS_WITH_PAGINATIONList contacts using GraphQL with forward cursor-based pagination. Returns contact information including ID, name, email, metadata, and timestamps, along with pagination details.

Input Parameters

string
Cursor for pagination. Returns contacts after this cursor. Use endCursor from previous response.
integer
Number of contacts to return. Use for forward pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONTACT_TASKSTool to retrieve a paginated list of tasks for a specific contact. Use when you need to view all tasks associated with a particular contact.

Input Parameters

integer
Number of task items to retrieve per page. Must be at least 1.
string ("asc" | "desc")
Sort order for paginated items.
string
Pagination cursor to retrieve the next page of results. Use the cursor value from the previous response to paginate through tasks.
string
required
The unique identifier of the contact to list tasks for. Can be obtained from the list contacts action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONVERSATION_MESSAGESTool to list messages in a conversation with pagination. Use after obtaining a conversation ID to fetch messages page by page.

Input Parameters

integer
Number of messages to retrieve; must be at least 1
string ("asc" | "desc")
Sort order of returned messages: ‘asc’ or ‘desc’.
string
Pagination cursor (message ID) to retrieve the next page of results. Use a message ID from a previous response to paginate.
string
required
Unique identifier of the conversation whose messages are to be listed. Can be obtained from the list conversations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONVERSATIONSTool to retrieve a paginated list of conversations. Use when you need to page through conversation history.

Input Parameters

integer
Number of items to retrieve; must be ≥ 1.
string ("asc" | "desc")
Sort order of returned items: ‘asc’ or ‘desc’.
string ("application/json" | "application/jsonl")
Response format header; set to ‘application/jsonl’ for streaming JSON Lines.
string
Pagination cursor; the ID of the last item from the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_CONVERSATIONS_GRAPHQLTool to retrieve conversations using GraphQL with cursor-based pagination. Use when you need to list all conversations with Relay-style pagination support.

Input Parameters

string
Cursor for pagination. Pass the endCursor from the previous page’s pageInfo to fetch the next page.
integer
Number of conversations to return per page. Defaults to 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_DATASET_FILESTool to retrieve a list of files in a dataset. Use when you need to browse or paginate through dataset files.

Input Parameters

integer
Number of files to retrieve per request. Must be at least 1.
string ("asc" | "desc")
Sort order for pagination
string
Cursor for pagination. Pass the ID of the last file from the previous response to get the next page.
string
required
The unique identifier of the dataset whose files are to be listed. Can be obtained from the list datasets action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_DATASET_RECORDSTool to list records in a dataset with pagination. Use after obtaining a dataset ID to retrieve all records or paginate through them.

Input Parameters

integer
Number of records to retrieve per request. Must be at least 1.
string ("asc" | "desc")
Order direction for paginated results.
string
Cursor for pagination. Pass the cursor from the previous response to get the next page.
string
required
The unique identifier of the dataset whose records are to be listed. Can be obtained from the list datasets action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_DATASETSTool to list datasets. Use when you need to browse or paginate through available datasets.

Input Parameters

integer
Number of datasets to retrieve per request.
string
Order of results. ‘desc’ returns newest first, ‘asc’ returns oldest first.
string
Cursor for pagination. Pass the ID of the last dataset from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_DATASETS_GRAPHQLTool to list all datasets using GraphQL with cursor-based pagination. Use when you need to browse datasets via GraphQL endpoint. Supports forward pagination with ‘first’ and ‘after’, or backward pagination with ‘last’ and ‘before’.

Input Parameters

integer
Number of datasets to retrieve (backward pagination). Use with ‘before’ cursor.
string
Cursor for forward pagination. Pass the endCursor from pageInfo to get the next page.
integer
Number of datasets to retrieve (forward pagination). Use with ‘after’ cursor.
string
Cursor for backward pagination. Pass the startCursor from pageInfo to get the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_DISCORD_INTEGRATIONSTool to retrieve a list of Discord integrations. Use when you need to browse or manage configured Discord integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Discord integrations by metadata.
integer
Number of Discord integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_EMAIL_INTEGRATIONSTool to retrieve a list of email integrations. Use when you need to browse or manage configured email integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter email integrations by metadata. Only integrations matching all specified metadata pairs will be returned.
integer
Number of email integrations to return in one page.
string ("asc" | "desc")
Order of the returned items (‘asc’ for ascending or ‘desc’ for descending). Defaults to ‘desc’.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_EVENT_LOGSTool to retrieve a paginated list of event logs. Use when you need to browse system events, audit activity, or analyze event history.

Input Parameters

object
Key-value pairs to filter event logs by metadata. Only event logs matching all specified metadata pairs will be returned.
integer
Maximum number of event logs to return per page. Must be at least 1.
string ("asc" | "desc")
Sort order for pagination.
string
Pagination cursor. Pass the cursor value from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_EVENT_METRICSTool to list event metrics for the authenticated account. Use when you need to retrieve analytics and monitoring data about platform events.

Input Parameters

integer
Number of event metrics to retrieve per request.
string
Order of results. ‘desc’ returns newest first, ‘asc’ returns oldest first.
string
Pagination cursor. Pass the ID of the last metric from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_EXTRACT_INTEGRATIONSTool to retrieve a list of Extract integrations. Use when you need to browse or manage configured Extract integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Extract integrations by metadata.
integer
Number of Extract integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_FILESTool to retrieve a list of files. Use when you need to browse or paginate through available files that can be attached to datasets.

Input Parameters

integer
Number of files to retrieve per request. Must be at least 1.
string ("asc" | "desc")
Sort order for pagination
string
Cursor for pagination. Pass the ID of the last file from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_FILES_GRAPHQLTool to list files using GraphQL query with connection-based pagination. Use when you need to retrieve files via GraphQL endpoint with edges/nodes structure.

Input Parameters

integer
Number of files to retrieve from the end. Used with ‘before’ cursor for backward pagination.
string
Cursor to paginate forward. Returns files after this cursor.
integer
Number of files to retrieve. Limit the result set size.
string
Cursor to paginate backward. Returns files before this cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_INSTAGRAM_INTEGRATIONSTool to retrieve a list of Instagram integrations. Use when you need to browse or manage configured Instagram integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Instagram integrations by metadata.
integer
Number of Instagram integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_INTEGRATIONS_GRAPHQLList integration records across multiple integration types using GraphQL, with a configurable page size per type. The response combines records and includes per-type pagination information.

Input Parameters

integer
Number of integrations to return per integration type. Controls page size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_MAGIC_PROMPTSTool to retrieve a list of magic prompts. Use when you need to browse or enumerate available magic prompts in the system.

Input Parameters

object
Key-value pairs to filter magic prompts by metadata.
integer
Number of magic prompts to retrieve per request.
string ("asc" | "desc")
Order direction for pagination.
string
Cursor for pagination. Pass the cursor value from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_MCP_SERVER_INTEGRATIONSTool to retrieve a list of MCP Server integrations. Use when you need to browse or manage configured MCP Server integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the MCP Server integrations by metadata.
integer
Number of MCP Server integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_MEMORIESTool to retrieve a paginated list of memories. Use when you need to browse or access memory entries across the system.

Input Parameters

object
Key-value pairs to filter memories by metadata. Only memories matching all specified metadata pairs will be returned.
integer
Number of memory items to retrieve; must be at least 1.
string ("asc" | "desc")
Order for pagination
string
Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_MESSAGES_GRAPHQLTool to list messages for one or more conversations using GraphQL. Returns messages in GraphQL connection pattern with edges/node structure. Use when you need to fetch messages across multiple conversations simultaneously.

Input Parameters

string
Cursor for forward pagination. Pass the endCursor from a previous response’s pageInfo to get the next page.
integer
Number of messages to retrieve. Use for forward pagination.
array
required
Array of conversation IDs to fetch messages for. Each ID uniquely identifies a conversation. Obtain IDs from the list conversations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_MESSENGER_INTEGRATIONSTool to retrieve a list of Messenger integrations. Use when you need to browse or manage configured Messenger integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Messenger integrations by metadata. Only integrations matching all specified metadata pairs will be returned.
integer
Number of Messenger integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_NOTION_INTEGRATIONSTool to retrieve a list of Notion integrations. Use when you need to browse or manage configured Notion integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Notion integrations by metadata.
integer
Number of Notion integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PARTNERSRetrieve a paginated list of partner user accounts associated with the main account, with cursor, ordering, and page-size options.

Input Parameters

integer
Maximum number of partner accounts to return per page.
string
Sort order for the results. Use ‘desc’ for descending (newest first) or ‘asc’ for ascending (oldest first).
string
Cursor for pagination. Use the ID of the last partner from the previous page to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_ABILITIESTool to retrieve a list of platform abilities. Use when you need to browse available abilities or capabilities provided by the platform.

Input Parameters

object
Key-value pairs to filter platform abilities by metadata.
integer
Maximum number of abilities to return per page.
string ("asc" | "desc")
Order for pagination results.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_ACTIONSTool to retrieve a paginated list of platform actions. Use when you need to browse available actions or discover what actions are supported by the platform.

Input Parameters

object
Key-value pairs to filter platform actions by metadata. Only actions matching all specified metadata pairs will be returned.
integer
Maximum number of platform actions to return per page. Must be at least 1.
string ("asc" | "desc")
Order of paginated items.
string
Pagination cursor. Pass the cursor from the previous page to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_DOCSTool to retrieve a list of platform documentation items. Use when you need to browse available documentation or discover what documentation is available for the ChatBotKit platform.

Input Parameters

object
Key-value pairs to filter the documentation items by metadata.
integer
Maximum number of documentation items to return per page.
string ("asc" | "desc")
Order for pagination results.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_EXAMPLESTool to retrieve a list of platform examples from ChatBotKit. Use when you need to browse available example templates and resources.

Input Parameters

object
Key-value pairs to filter platform examples by metadata.
integer
Number of platform examples to retrieve per request.
string ("asc" | "desc")
Sort order for platform examples.
string
Cursor for pagination. Pass the cursor from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_GUIDESTool to retrieve a list of platform guides. Use when you need to browse available guides or tutorials for the platform.

Input Parameters

object
Key-value pairs to filter platform guides by metadata.
integer
Number of platform guides to retrieve per request.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Pass the cursor from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_MANUALSTool to retrieve a list of platform manuals. Use when you need to browse available documentation and help resources for the ChatBotKit platform.

Input Parameters

object
Key-value pairs to filter platform manuals by metadata.
integer
Number of platform manuals to retrieve per request.
string ("asc" | "desc")
Sort order for listing platform manuals.
string
Cursor for pagination. Pass the cursor from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_MODELSTool to retrieve a list of available platform models. Use when you need to browse AI models available on the platform.

Input Parameters

object
Key-value pairs to filter platform models by metadata.
integer
Maximum number of models to return per page.
string ("asc" | "desc")
Order for pagination results.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_REPORTSTool to retrieve a list of available platform reports. Use when you need to view or analyze system-generated reports.

Input Parameters

integer
Number of reports to retrieve per request.
string ("asc" | "desc")
Order of paginated items.
string
Cursor for pagination. Pass the ID of the last report from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_SECRETSTool to retrieve a paginated list of platform secrets. Use when you need to browse or access secret entries at the platform level.

Input Parameters

object
Key-value pairs to filter platform secrets by metadata. Only secrets matching all specified metadata pairs will be returned.
integer
Number of secret items to retrieve per page; must be at least 1.
string ("asc" | "desc")
Order for pagination
string
Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PLATFORM_TUTORIALSTool to retrieve a list of platform tutorials. Use when you need to browse or discover available tutorials for learning how to use the ChatBotKit platform.

Input Parameters

object
Key-value pairs to filter tutorials by metadata.
integer
Number of tutorials to retrieve per request.
string ("asc" | "desc")
Sort order for paginated results.
string
Cursor for pagination. Pass the cursor from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_POLICIESTool to retrieve a list of policies. Use when you need to browse available policies or filter by metadata.

Input Parameters

object
Key-value pairs to filter policies by metadata. Only policies matching all specified metadata fields will be returned.
integer
Number of policies to return per page
string ("asc" | "desc")
Order direction for pagination.
string
Cursor for pagination. Use the cursor value from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PORTALSTool to retrieve a list of portals. Use when you need to browse or paginate through available portals.

Input Parameters

object
Key-value pairs to filter portals by metadata. Only portals matching all specified metadata pairs will be returned.
integer
Number of portals to retrieve per request.
string ("asc" | "desc")
Sort order of returned items: ‘asc’ for ascending or ‘desc’ for descending. Defaults to ‘desc’.
string
Cursor for pagination. Pass the cursor value from the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_PORTALS_GRAPHQLTool to retrieve a paginated list of portals using GraphQL. Use when you need to query portals via GraphQL with cursor-based pagination.

Input Parameters

string
Cursor for forward pagination. Pass the endCursor from the previous response to get the next page.
integer
Number of portals to retrieve (forward pagination). Defaults to 10 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SECRETSList secrets and their metadata for external service integrations, with cursor-based pagination.

Input Parameters

integer
Number of secret items to retrieve per page; must be at least 1.
string ("asc" | "desc")
Order for pagination
string
Pagination cursor to retrieve the next page of results. Use a cursor from a previous response to paginate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SECRETS_GRAPHQLTool to list all secrets using GraphQL with cursor-based pagination. Use when you need to retrieve secrets stored in ChatBotKit. Supports forward pagination with ‘first’ and ‘after’, or backward pagination with ‘last’ and ‘before’.

Input Parameters

integer
Number of secrets to retrieve (backward pagination). Use with ‘before’ cursor.
string
Cursor for forward pagination. Pass the endCursor from pageInfo to get the next page.
integer
Number of secrets to retrieve (forward pagination). Use with ‘after’ cursor.
string
Cursor for backward pagination. Pass the startCursor from pageInfo to get the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SITEMAP_INTEGRATIONSTool to retrieve a list of Sitemap integrations. Use when you need to browse or manage configured Sitemap integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Sitemap integrations by metadata.
integer
Number of Sitemap integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SKILLSET_ABILITIESTool to retrieve a list of abilities within a specific skillset. Use when you need to enumerate abilities for a given skillset.

Input Parameters

integer
Number of abilities to return per page
string ("asc" | "desc")
Order of paginated items.
string
Cursor for pagination. Use the cursor value from a previous response to fetch the next page.
string
required
The ID of the skillset to retrieve abilities from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SKILLSETSRetrieve a page of skillsets, with cursor-based pagination for enumerating available skillsets.

Input Parameters

integer
Number of skillsets to return per page (default is typically 25)
string
Cursor for pagination. Use the cursor value from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SKILLSETS_GRAPHQLTool to list skillsets using GraphQL query with connection-based pagination. Use when you need to retrieve skillsets via GraphQL endpoint with edges/nodes structure.

Input Parameters

integer
Number of skillsets to retrieve from the end. Used with ‘before’ cursor for backward pagination.
string
Cursor to paginate forward. Returns skillsets after this cursor.
integer
Number of skillsets to retrieve. Limit the result set size.
string
Cursor to paginate backward. Returns skillsets before this cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SLACK_INTEGRATIONSTool to retrieve a list of Slack integrations. Use when you need to browse or manage configured Slack integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Slack integrations by metadata.
integer
Number of Slack integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SPACESTool to retrieve a paginated list of spaces. Spaces are containers for organizing bot resources. Use when you need to browse or manage multiple spaces.

Input Parameters

object
Key-value pairs to filter spaces by metadata. Only spaces matching all specified metadata pairs will be returned.
integer
Maximum number of spaces to return per page. Must be at least 1.
string ("asc" | "desc")
Sort order for pagination.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_SUPPORT_INTEGRATIONSTool to retrieve a list of support integrations. Use when you need to browse or manage configured support integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the support integrations by metadata.
integer
The number of items to retrieve per page.
string ("asc" | "desc")
Order of the paginated items.
string
The cursor to use for pagination. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_TASKSTool to retrieve a paginated list of tasks. Use when you need to view all tasks, optionally filtered by bot, contact, status, or metadata.

Input Parameters

object
Key-value pairs to filter tasks by metadata. Only tasks matching all specified metadata pairs will be returned.
integer
Number of task items to retrieve per page. Must be at least 1.
string
Filter tasks by associated bot ID. Only tasks associated with this bot will be returned.
string ("asc" | "desc")
Sort order for paginated items.
string
Pagination cursor to retrieve the next page of results. Use the cursor value from the previous response to paginate through tasks.
string ("idle" | "running")
Status of a task.
string
Filter tasks by associated contact ID. Only tasks associated with this contact will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_TEAMSTool to retrieve a paginated list of teams. Use when you need to browse or manage multiple teams.

Input Parameters

object
Key-value pairs to filter teams by metadata. Only teams matching all specified metadata pairs will be returned.
integer
Maximum number of teams to return per page. Must be at least 1.
string ("asc" | "desc")
Sort order for pagination.
string
Pagination cursor. Pass the cursor from the previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_TELEGRAM_INTEGRATIONSTool to retrieve a list of Telegram integrations. Use when you need to browse or manage configured Telegram integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Telegram integrations by metadata.
integer
Number of Telegram integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_TOKENSTool to retrieve a list of all API tokens. Use when you need to audit or manage existing tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_TWILIO_INTEGRATIONSTool to retrieve a list of Twilio integrations. Use when you need to browse or manage configured Twilio integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the Twilio integrations by metadata. Only integrations matching all specified metadata pairs will be returned.
integer
Number of Twilio integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_WHATS_APP_INTEGRATIONSTool to retrieve a list of WhatsApp integrations. Use when you need to browse or manage configured WhatsApp integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the WhatsApp integrations by metadata.
integer
Number of WhatsApp integrations to return in one page.
string ("asc" | "desc")
Order enum for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_LIST_WIDGET_INTEGRATIONSTool to retrieve a list of widget integrations. Use when you need to browse or manage configured widget integrations and iterate pages via cursor.

Input Parameters

object
Key-value pairs to filter the widget integrations by metadata.
integer
Number of widget integrations to return in one page.
string ("asc" | "desc")
Order direction for pagination.
string
Pagination cursor. Provide to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_PUBLISH_CHANNEL_MESSAGEPublish a message to a ChatBotKit channel. Use this action when you need to send messages to a specific channel identified by its channel ID.

Input Parameters

object
required
The message object to publish to the channel. Contains the message type and text content.
string
required
The unique identifier of the channel to publish the message to. Must be at least 16 characters long.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_BOT_MEMORYTool to search memories for a specific bot. Use when you need to retrieve stored memories that match a keyword or phrase.

Input Parameters

string
required
The ID of the bot to search memories for
string
required
The keyword or phrase to search for in bot memories

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_CONTACT_MEMORYTool to search memories for a specific contact by keyword or phrase. Use when you need to find specific information stored in a contact’s memory.

Input Parameters

string
required
The keyword or phrase to search for within the contact’s memories. Returns memories containing this text.
string
required
Unique identifier of the contact whose memories to search. The contact ID can be obtained from contact-related actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_DATASETTool to search a dataset for records matching a given search query. Uses semantic search for finding relevant records. Use when you need to retrieve stored data from a dataset based on a keyword or phrase.

Input Parameters

object
Optional filter object to narrow results by field values. Supports operators like $eq, $ne, $gt, $gte, $lt, $lte.
string
required
The keyword or phrase to search for in the dataset. Uses semantic search to find relevant records.
string
required
The ID of the dataset to search. Obtain this from list_datasets or when creating a dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_MEMORYTool to search memories for records matching a given search query. Use when you need to find specific memories, optionally filtered by bot or contact.

Input Parameters

string
The ID of the bot to filter memories by. If provided, only memories associated with this bot will be searched.
string
required
The keyword or phrase to search for in memories
string
The ID of the contact to filter memories by. If provided, only memories associated with this contact will be searched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_ABILITIESTool to search platform abilities using semantic similarity. Use when you need to find relevant abilities or tools based on a query.

Input Parameters

integer
The maximum number of search results to return (1-100). Defaults to 10.
string
required
The search query to find relevant abilities using semantic similarity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_DOCSTool to search platform documentation using semantic similarity. Use when you need to find relevant documentation, guides, or help articles based on a query.

Input Parameters

integer
The maximum number of search results to return (1-100). Defaults to 10.
string
required
The search query to find relevant documentation using semantic similarity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_DOCS_GRAPHQLTool to search platform documentation by search query via GraphQL and retrieve docs with id, name, excerpt, and link. Use when you need to find relevant ChatBotKit documentation using the GraphQL API.

Input Parameters

integer
Number of results to return. Limits the response size.
string
Search query to find relevant documentation. If not provided, returns all documentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_EXAMPLESTool to search platform examples using semantic similarity. Use when you need to find relevant examples, templates, or code snippets from the platform’s example library.

Input Parameters

integer
The maximum number of results to return (1-100, default 10)
string
required
The search query to find relevant examples using semantic similarity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_GUIDESTool to search platform guides using semantic similarity. Use when you need to find relevant documentation, tutorials, or guides based on a search query.

Input Parameters

integer
The maximum number of results to return. Defaults to 10 if not specified.
string
required
The search query to find relevant guides using semantic similarity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_MANUALSTool to search platform manuals using semantic similarity. Use when you need to find documentation, guides, or help resources related to a specific topic or question.

Input Parameters

integer
The maximum number of results to return. Defaults to 10 if not specified.
string
required
The search query to find relevant manuals using semantic similarity. This searches through documentation, guides, and help resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_SECRETSTool to search platform secrets using semantic similarity. Use when you need to find secrets that match a particular topic or keyword using intelligent matching.

Input Parameters

integer
The maximum number of results to return. Must be between 1 and 100. Defaults to 10 if not specified.
string
required
The search query to find relevant secrets. The system uses semantic similarity matching to find secrets related to this query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SEARCH_PLATFORM_TUTORIALSTool to search platform tutorials using semantic similarity. Use when you need to find relevant tutorials, documentation, or guides on specific topics.

Input Parameters

integer
The maximum number of results to return. Must be between 1 and 100. Defaults to 10 if not specified.
string
required
The search query to find relevant tutorials. The search uses semantic similarity to match your query against tutorial content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SET_UP_EMAIL_INTEGRATIONTool to setup an email integration in ChatBotKit. Use when you need to activate or configure an existing email integration for use with a bot.

Input Parameters

string
required
The ID of the email integration to setup. Use the List Integrations action to find available email integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SET_UP_TRIGGER_INTEGRATIONTool to setup a trigger integration in ChatBotKit. Use when you need to activate or configure an existing trigger integration for use with a bot.

Input Parameters

string
required
The ID of the trigger integration to setup. Use the List Integrations action to find available trigger integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SET_UP_TWILIO_INTEGRATIONTool to setup a Twilio integration in ChatBotKit. Use when you need to activate or configure an existing Twilio integration for use with a bot.

Input Parameters

string
required
The ID of the Twilio integration to setup. Use the List Integrations action to find available Twilio integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SET_UP_WHATS_APP_INTEGRATIONTool to setup a WhatsApp integration in ChatBotKit. Use when you need to activate or configure an existing WhatsApp integration for use with a bot.

Input Parameters

string
required
The ID of the WhatsApp integration to setup. Use the List Integrations action to find available WhatsApp integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SET_UP_WIDGET_INTEGRATIONTool to setup a Widget integration in ChatBotKit. Use when you need to activate or configure an existing Widget integration for use with a bot.

Input Parameters

string
required
The ID of the Widget integration to setup. Use the List Integrations action to find available Widget integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SUBSCRIBE_CHANNELSubscribe to a ChatBotKit channel and return collected message events, optionally requesting historical messages. The tool reads at most 100 events and returns those collected when the stream ends or times out, rather than providing an ongoing live stream.

Input Parameters

string
required
The unique identifier of the channel to subscribe to. Must be at least 16 characters long.
integer
Number of historical messages to replay from the channel before subscribing to live updates. When provided, the subscriber will first receive up to this many recent messages that were published before the subscription started. This is useful for catching up on messages that may have been published during connection setup. Valid range: 0-10000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SYNC_DATASET_FILETool to sync a dataset file. Use when you need to synchronize a file within a dataset to ensure its content is up-to-date and available for use by the bot.

Input Parameters

string
required
The ID of the file to sync
string
required
The ID of the dataset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SYNC_FILETool to sync a file. Use when you need to synchronize a file to ensure its content is up-to-date and available for use.

Input Parameters

string
required
The ID of the file to sync

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SYNC_NOTION_INTEGRATIONTool to sync a Notion integration with ChatBotKit. Use when you need to manually trigger synchronization of content between Notion pages and the associated ChatBotKit dataset.

Input Parameters

string
required
The unique identifier of the Notion integration to sync. Obtain this ID from the list_integrations or create_notion_integration actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SYNC_SITEMAP_INTEGRATIONTool to sync a sitemap integration. Use when you need to trigger an immediate sync of a sitemap integration to refresh the dataset with the latest content from the website.

Input Parameters

string
required
The ID of the sitemap integration to sync

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_SYNTHESIZE_CONVERSATION_MESSAGETool to convert a conversation message into speech audio. Use when you need to synthesize text from a message into audio format.

Input Parameters

string
required
The unique identifier of the message to synthesize into speech. Obtain this from list_conversation_messages.
string
required
The unique identifier of the conversation containing the message. Obtain this from list_conversations or when creating a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_TRIGGER_EXTRACT_INTEGRATIONTool to trigger an extract integration on historic conversations in ChatBotKit. Use when you need to process past conversations with an extract integration, either by specifying a sample size or specific conversation IDs.

Input Parameters

integer
Number of recent conversations to process (default 20, min 1, max 100). Use this to limit processing to the N most recent conversations.
array
Array of specific conversation IDs to process. If provided, only these conversations will be processed instead of using the sample parameter.
string
required
The ID of the extract integration to trigger. Use the List Integrations action to find available extract integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_TRIGGER_SUPPORT_INTEGRATIONTool to trigger a support integration on historic conversations in ChatBotKit. Use when you need to process past conversations with a support integration, either by specifying a sample size or specific conversation IDs.

Input Parameters

integer
Number of recent conversations to process (default 20, min 1, max 1000). Use this to limit processing to the N most recent conversations.
array
Array of specific conversation IDs to process. If provided, only these conversations will be processed instead of using the sample parameter.
string
required
The ID of the support integration to trigger. Use the List Integrations action to find available support integration IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_TRIGGER_TASKTool to trigger execution of a background task. Use when you need to manually start or restart a task.

Input Parameters

string
required
The unique identifier of the task to trigger

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_BLUEPRINTTool to update an existing blueprint. Use when you need to modify blueprint properties such as name, description, visibility, or metadata.

Input Parameters

object
Additional metadata to associate with the blueprint as key-value pairs.
string
The name of the blueprint. This is the display name that identifies the blueprint.
string
The unique alias for the blueprint. This provides a human-readable identifier.
string
Visibility setting for the blueprint. Controls who can access this blueprint.
string
required
The unique identifier of the blueprint to update. Use the List Blueprints action to find available blueprint IDs.
string
A description explaining the purpose or functionality of this blueprint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_BLUEPRINT_GRAPHQLTool to update an existing blueprint using GraphQL mutation. Use when you need to modify a blueprint’s properties via the GraphQL API.

Input Parameters

object
required
Input object containing the fields to update for the blueprint.
string
required
The unique identifier of the blueprint to update. This is a required parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_BOTTool to update an existing bot’s configuration and properties. Use when you need to modify a bot’s name, description, model, backstory, associated datasets/skillsets, or other settings.

Input Parameters

object
Additional metadata to associate with the bot as key-value pairs.
string
Updated name for the bot. Provide a clear, descriptive name.
string
A unique alias identifier for the bot that can be used instead of the bot ID.
string
required
The unique identifier of the bot to update. This is a required path parameter.
string
The AI model to use for the bot. Format: model_name or model_name/param=value.
boolean
Privacy flag for the bot configuration. When true, enables privacy features.
string
The system prompt or backstory that defines the bot’s personality and behavior instructions.
string
The ID of the dataset to associate with this bot for knowledge retrieval.
boolean
Moderation flag for the bot configuration. When true, enables content moderation.
string
The ID of the skillset to associate with this bot for enhanced capabilities.
string ("private" | "protected" | "public")
Visibility levels for a bot.
string
The ID of the blueprint this bot is based on or should be updated to use.
string
Updated description explaining the purpose or functionality of the bot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_BOT_GRAPHQLTool to update an existing bot using GraphQL mutation. Use when you need to modify a bot’s properties via the GraphQL API.

Input Parameters

string
required
The unique identifier of the bot to update. This is a required parameter.
object
required
Input object containing the fields to update for the bot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_CONTACTTool to update an existing contact’s information. Use when you need to modify contact details like email, nickname, phone number, or preferences.

Input Parameters

string
Updated nickname or display name for the contact.
string
Updated email address for the contact.
string
Updated phone number for the contact.
string
required
The unique identifier of the contact to update. This is the ID of an existing contact that you want to modify.
string
Updated fingerprint identifier for the contact. Used to uniquely identify the contact across sessions.
string
Updated preferences for the contact as a JSON string or serialized data.
integer
Unix timestamp (in milliseconds) when the contact was verified. Set this to mark when contact verification occurred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_CONVERSATIONTool to update an existing conversation’s properties. Use when you need to modify conversation metadata, bot configuration, or associated resources like contacts, tasks, or spaces.

Input Parameters

object
Metadata object for storing custom key-value pairs associated with the conversation. Accepts string key-value pairs.
string
The name to assign to the conversation. This is the display name that identifies the conversation.
string
The ID of the bot to associate with this conversation. Mutually exclusive with bot configuration fields.
string
Language model to use for the conversation (e.g., ‘gpt-4-turbo’, ‘gpt-3.5-turbo’). Part of bot configuration.
string
The task ID to assign to this conversation.
boolean
Whether privacy mode is enabled for this conversation.
string
The space ID to assign to this conversation.
string
Background context and personality for the conversation. Defines how the bot should behave in this conversation.
string
The contact ID to assign to this conversation.
string
ID of the dataset for knowledge retrieval in this conversation.
boolean
Whether moderation is enabled for this conversation.
string
ID of the skillset to provide specific capabilities for this conversation.
string
The description of the conversation. Provides additional context about the conversation purpose.
string
required
The unique identifier of the conversation to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_CONVERSATION_MESSAGETool to update an existing message in a conversation. Use this to modify the text, entities, or type of a previously created message.

Input Parameters

string
The updated text content of the message.
string ("user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity")
The type of message. Options: ‘user’ for user messages, ‘bot’ for bot responses, ‘context’ for contextual information, ‘instruction’ for instructions, ‘backstory’ for background information, ‘reasoning’ for reasoning steps, ‘activity’ for activity logs.
array
Optional array of entities to associate with this message. Entities are structured data extracted from the message text.
string
required
The unique identifier of the message to update. Obtain this from list_conversation_messages or when creating a message.
string
required
The unique identifier of the conversation containing the message to update. Obtain this from list_conversations or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_DATASETTool to update an existing dataset’s configuration and properties. Use when you need to modify a dataset’s name, description, visibility, search settings, or other configuration options.

Input Parameters

object
Additional metadata to associate with the dataset as key-value pairs.
string
The name of the dataset. This is the display name that identifies the dataset.
string
The unique alias for the dataset. This provides a human-readable identifier.
string
The storage class for the dataset. Defines how the dataset data is stored.
string
The reranker class for the dataset. Used to improve search result relevance.
string
required
The unique identifier of the dataset to update. This is a required path parameter.
string
Separator characters to use for splitting dataset content.
string ("private" | "protected" | "public")
Visibility levels for a dataset.
string
A description explaining the purpose or contents of this dataset.
number
Minimum similarity score threshold for search results.
number
Maximum number of tokens per record in the dataset.
number
Maximum number of tokens to use for search results.
string
Instructions to apply when a search match is found.
number
Maximum number of records to return in search results.
string
Instructions to apply when no search match is found.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_DATASET_GRAPHQLTool to update an existing dataset using GraphQL mutation. Use when you need to modify a dataset’s properties such as name, description, search configuration, visibility, or metadata via the GraphQL API endpoint.

Input Parameters

object
required
Input object containing the fields to update for the dataset.
string
required
The unique identifier of the dataset to update. This is a required parameter for the mutation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_DATASET_RECORDTool to update an existing record in a dataset. Use when you need to modify text data or metadata in an existing dataset record.

Input Parameters

object
Updated metadata object for storing additional custom information about this record.
string
Updated text content of the record. This is the main data stored in the dataset record.
string
Updated source identifier for the record. Use to track where the record originated from.
string
required
The unique identifier of the record to update. This is the ID of the specific record within the dataset.
string
required
The unique identifier of the dataset containing the record to update. Obtain this from list_datasets or when creating a dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_DISCORD_INTEGRATIONTool to update an existing Discord integration’s configuration. Use when you need to modify Discord integration settings such as bot token, session duration, contact collection, or associated bot/blueprint.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the Discord integration.
string
The Discord application ID.
string
The ID of the bot to use for this Discord integration.
string
The handle or username for the Discord integration.
string
The Discord bot token for authentication.
string
The Discord application public key.
string
The ID of the blueprint to associate with this Discord integration.
string
Updated description explaining the purpose of this Discord integration.
integer
Session duration in seconds. Controls how long a conversation session remains active.
boolean
Whether to enable contact collection for this Discord integration.
string
required
The unique identifier of the Discord integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_EMAIL_INTEGRATIONTool to update an existing Email integration’s configuration and properties. Use when you need to modify an Email integration’s settings such as allowed sender emails, attachment handling, contact collection, or session duration.

Input Parameters

object
Additional metadata to associate with the Email integration as key-value pairs.
string
The name of the Email integration. This is the display name that identifies the integration.
string
The unique identifier of the bot to associate with this Email integration.
boolean
Whether to enable attachment handling for emails received through this integration.
string
The ID of the blueprint this Email integration is based on or should be updated to use.
string
A description explaining the purpose or configuration of this Email integration.
number
Duration in seconds for how long an email conversation session should remain active.
boolean
Whether to enable automatic contact collection from email senders.
string
required
The unique identifier of the Email integration to update. This is a required path parameter.
string
Comma-separated list or pattern of allowed sender email addresses for this integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_EXTRACT_INTEGRATIONTool to update an existing Extract integration’s configuration. Use when you need to modify an Extract integration’s model, extraction request, schema, associated bot, or other settings.

Input Parameters

object
Additional metadata to associate with the Extract integration as key-value pairs.
string
Updated name for the Extract integration. Provide a clear, descriptive name.
string
The ID of the bot to associate with this Extract integration.
string
The AI model to use for extraction. Specify the model name such as ‘gpt-4’, ‘gpt-3.5-turbo’, or ‘claude-3-opus’.
object
JSON schema defining the structure of the data to extract. This schema specifies the expected output format.
string
The extraction request or prompt that defines what information to extract from conversations.
string
The ID of the blueprint to associate with this Extract integration.
string
Updated description explaining the purpose of this Extract integration.
string
required
The ID of the Extract integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_FILETool to update an existing file’s metadata and properties. Use when you need to modify a file’s name, description, visibility, or other configuration settings.

Input Parameters

object
Additional metadata to associate with the file as key-value pairs.
string
The name of the file. This is the display name that identifies the file.
string
The unique alias for the file. This provides a human-readable identifier.
string
required
The unique identifier of the file to update. This is a required path parameter.
string ("private" | "protected" | "public")
Visibility levels for a file.
string
The ID of the blueprint to associate with this file.
string
A description explaining the purpose or contents of this file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_FILE_GRAPHQLTool to update an existing file using GraphQL mutation. Use when you need to modify a file’s name, description, visibility, or other properties via the GraphQL API endpoint.

Input Parameters

object
required
Input object containing the fields to update for the file.
string
required
The unique identifier of the file to update. This is a required parameter for the mutation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_INSTAGRAM_INTEGRATIONTool to update an existing Instagram integration’s configuration. Use when you need to modify Instagram integration settings such as access token, session duration, contact collection, attachments, or associated bot/blueprint.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the Instagram integration.
string
The ID of the bot to use for this Instagram integration.
string
The Instagram access token for authentication and API access.
boolean
Whether to enable attachments for this Instagram integration.
string
The ID of the blueprint to associate with this Instagram integration.
string
Updated description explaining the purpose of this Instagram integration.
integer
Session duration in seconds. Controls how long a conversation session remains active.
boolean
Whether to enable contact collection for this Instagram integration.
string
required
The unique identifier of the Instagram integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_INTEGRATION_GRAPHQLTool to update trigger integration configuration and settings using GraphQL mutation. Use when you need to modify a trigger integration’s properties such as name, description, metadata, authentication settings, or associated bot/blueprint via the GraphQL API.

Input Parameters

object
required
Input object containing the fields to update for the trigger integration.
string
required
The unique identifier of the trigger integration to update. This is a required parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_MCPSERVER_INTEGRATIONTool to update an existing MCP Server integration. Use when you need to modify properties of an MCP (Model Context Protocol) Server integration such as name, description, associated skillset or blueprint, or metadata.

Input Parameters

object
Optional metadata for the integration. Key-value pairs for organizing or tagging the integration.
string
Updated name for the MCP Server integration. A human-readable identifier for this integration.
string
Optional skillset ID to associate with the integration. Use the List Skillsets action to find available skillset IDs.
string
Optional blueprint ID to associate with the integration. Blueprints provide template configurations.
string
Updated description explaining the purpose or function of this MCP Server integration.
string
required
The unique identifier of the MCP Server integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_MEMORYTool to update an existing memory’s text or associations. Use when you need to modify memory content or change its bot/contact associations.

Input Parameters

string
Updated memory text content. This is the main content of the memory that will be stored.
string
The ID of the bot associated with this memory. Use to change bot association.
string
required
The unique identifier of the memory to update. This is a required path parameter.
string
The ID of the contact associated with this memory. Use to change contact association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_MESSENGER_INTEGRATIONTool to update an existing Messenger integration’s configuration. Use when you need to modify Messenger integration settings such as access token, session duration, attachments, or associated bot/blueprint.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the Messenger integration.
string
The ID of the bot to use for this Messenger integration.
string
The Facebook Page Access Token for authentication and API access.
boolean
Whether to enable attachments for this Messenger integration.
string
The ID of the blueprint to associate with this Messenger integration.
string
Updated description explaining the purpose of this Messenger integration.
integer
Session duration in seconds. Controls how long a conversation session remains active.
string
required
The unique identifier of the Messenger integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_NOTION_INTEGRATIONTool to update an existing Notion integration’s configuration and properties. Use when you need to modify a Notion integration’s settings such as sync schedule, token, dataset association, or expiration settings.

Input Parameters

object
Additional metadata to associate with the Notion integration as key-value pairs.
string
The name of the Notion integration. This is the display name that identifies the integration.
string
The Notion API token for authentication. Use this to update the integration’s access token.
string
The unique identifier of the dataset to associate with this Notion integration.
number
Duration in seconds for how long the integration token remains valid before expiring.
string
The ID of the blueprint this Notion integration is based on or should be updated to use.
string
A description explaining the purpose or configuration of this Notion integration.
string
The schedule for automatic synchronization of Notion data. Examples: ‘daily’, ‘weekly’, ‘monthly’.
string
required
The unique identifier of the Notion integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_PARTNER_USERTool to update an existing partner user’s information. Use when you need to modify partner user details like email, profile image, or resource limits.

Input Parameters

string
Updated email address for the partner user.
string
Updated profile image URL for the partner user.
object
Updated resource limits for the partner user account. Key-value pairs defining usage restrictions or quotas.
string
required
The unique identifier of the partner user to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_RATINGTool to update an existing rating by ID. Use when you need to modify a rating’s value or associated metadata. Ratings track user feedback (upvotes/downvotes) for contacts, bots, conversations, and messages.

Input Parameters

string
required
The unique identifier of the rating to update. This is a required path parameter.
object
Additional metadata for the rating as key-value pairs.
string
Name or title for the rating.
string
The bot ID associated with the rating.
integer ("-1" | "1")
Rating value enum for upvotes and downvotes.
string
Reason for the rating. Provides context for the rating value.
string
The contact ID associated with the rating.
string
The message ID associated with the rating.
string
Description of the rating.
string
The conversation ID associated with the rating.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SECRETTool to update an existing secret’s configuration and properties. Use when you need to modify a secret’s name, description, value, type, or other settings.

Input Parameters

string ("shared" | "personal")
Storage type for the secret
object
Additional metadata to associate with the secret as key-value pairs.
string
Updated identifier for the secret. This is the display name that identifies the secret.
string ("plain" | "basic" | "bearer" | "oauth" | "template")
Authentication method type for the secret
string
The unique alias for the secret. This provides a human-readable identifier.
string
Updated credential data (e.g., API key, token, password). This will be encrypted at rest by ChatBotKit.
object
Configuration object for the secret. Used for additional settings or parameters.
string
required
The unique identifier of the secret to update. This is a required path parameter.
string ("private" | "public")
Access control level for the secret
string
The ID of the blueprint this secret is associated with.
string
Updated description of the secret. Explains what this secret is used for or which service it authenticates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SECRET_GRAPHQLTool to update an existing secret via GraphQL mutation. Use when you need to modify a secret’s properties using the GraphQL API.

Input Parameters

object
required
Input object containing the fields to update for the secret.
string
required
The unique identifier of the secret to update. This is a required GraphQL variable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SITEMAP_INTEGRATIONTool to update an existing Sitemap integration’s configuration. Use when you need to modify sitemap URL, glob patterns, sync schedule, dataset association, or crawling settings like JavaScript rendering and CSS selectors.

Input Parameters

string
The URL of the sitemap.xml file to crawl and index.
string
Glob pattern to filter which URLs from the sitemap should be processed. Use patterns like ’**/*.html’ to match specific paths.
object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the Sitemap integration.
string
The ID of the dataset to store the crawled sitemap content.
number
Expiration time in seconds for cached sitemap content. Controls how long crawled data remains valid.
string
CSS selectors to extract specific content from crawled pages. Use comma-separated selectors to target multiple elements.
boolean
Whether to enable JavaScript rendering when crawling sitemap URLs. Enable this if the target pages use client-side rendering.
string
The ID of the blueprint to associate with this Sitemap integration.
string
Updated description explaining the purpose of this Sitemap integration.
string
Schedule for automatically syncing the sitemap. Common values include ‘daily’, ‘weekly’, ‘hourly’.
string
required
The unique identifier of the Sitemap integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SKILLSETTool to update an existing skillset’s configuration and properties. Use when you need to modify a skillset’s name, description, visibility, or other settings.

Input Parameters

object
Additional metadata to associate with the skillset as key-value pairs.
string
The name of the skillset. This is the display name that identifies the skillset.
string
The unique alias for the skillset. This provides a human-readable identifier.
string
required
The unique identifier of the skillset to update. This is a required path parameter.
string ("private" | "protected" | "public")
Visibility levels for a skillset.
string
A description explaining the purpose or contents of this skillset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SKILLSET_ABILITYTool to update an existing ability within a skillset. Use when you need to modify ability properties like name, description, instruction, or associated resources.

Input Parameters

object
Additional metadata to associate with the ability as key-value pairs.
string
Updated name for the ability. Provide a clear, descriptive name.
string
The ID of the bot associated with this ability.
string
The ID of a file resource associated with this ability.
string
The ID of the space this ability belongs to.
string
Updated ID of the secret for authentication. Use when the ability needs to authenticate with external services.
string
required
The unique identifier of the ability to update.
string
required
The unique identifier of the skillset containing the ability to update.
string
The ID of the blueprint this ability is based on or should be updated to use.
string
Updated description of what the ability does. Explains the purpose and functionality.
string
Updated instruction including fetch block for external API calls. Defines how the ability should interact with external services or APIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SKILLSET_GRAPHQLUpdate an existing skillset using a GraphQL mutation, including its name, description, alias, blueprint, visibility, or metadata.

Input Parameters

object
required
Input object containing the fields to update for the skillset.
string
required
The unique identifier of the skillset to update. This is a required parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SLACK_INTEGRATIONTool to update an existing Slack integration’s configuration. Use when you need to modify Slack integration settings such as bot token, signing secret, session duration, contact collection, ratings, or associated bot/blueprint.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the Slack integration.
string
The ID of the bot to use for this Slack integration. Use the List Bots action to find available bot IDs.
boolean
Whether to enable ratings feature allowing users to rate bot responses.
string
The Slack Bot User OAuth Token from OAuth & Permissions page. Required for bot functionality.
string
Slack user token for additional permissions beyond bot token capabilities.
boolean
Whether to enable references feature for providing source citations.
string
Auto-respond configuration for the Slack integration. Determines when the bot responds to messages.
string
The ID of the blueprint to associate with this Slack integration.
string
Updated description explaining the purpose of this Slack integration.
string
The Slack signing secret from your Slack App’s Basic Information section. Used to verify requests from Slack.
integer
Session duration in seconds. Defines how long a conversation session remains active.
integer
Number of visible messages to display in the conversation history.
boolean
Whether to enable contact collection for tracking user interactions.
string
required
The unique identifier of the Slack integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SPACETool to update an existing space’s configuration and properties. Use when you need to modify a space’s name, description, associated blueprint, contact, or other settings.

Input Parameters

object
Additional metadata to associate with the space as key-value pairs.
string
Updated name for the space. Provide a clear, descriptive name.
string
The unique alias for the space. This provides a human-readable identifier.
string
required
The unique identifier of the space to update. This is a required path parameter.
string
The ID of the contact to associate with this space.
string
The ID of the blueprint to associate with this space.
string
Updated description explaining the purpose or functionality of the space.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_SUPPORT_INTEGRATIONTool to update an existing Support integration’s configuration and properties. Use when you need to modify a Support integration’s email, name, description, or associated bot/blueprint.

Input Parameters

object
Additional metadata to associate with the Support integration as key-value pairs.
string
The name of the Support integration. This is the display name that identifies the integration.
string
The unique identifier of the bot to associate with this Support integration.
string
The email address associated with this Support integration. Used for receiving and managing support requests.
string
The ID of the blueprint this Support integration is based on or should be updated to use.
string
A description explaining the purpose or configuration of this Support integration.
string
required
The unique identifier of the Support integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_TASKTool to update an existing task’s configuration and properties. Use when you need to modify a task’s schedule, bot/contact associations, or execution parameters.

Input Parameters

string
Updated bot ID to associate with this task.
string
required
The unique identifier of the task to update. This is a required path parameter.
number
Updated maximum time allowed for this task execution (in seconds or milliseconds).
string
Updated schedule for the task using cron expression format (e.g., ‘0 9 * * *’ for 9 AM daily).
string
Updated contact ID to associate with this task.
number
Updated maximum number of iterations allowed for this task.
number
Updated session duration for the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_TELEGRAM_INTEGRATIONTool to update an existing Telegram integration’s configuration and properties. Use when you need to modify a Telegram integration’s settings such as bot token, session duration, attachment handling, or associated bot/blueprint.

Input Parameters

object
Additional metadata to associate with the Telegram integration as key-value pairs.
string
The name of the Telegram integration. This is the display name that identifies the integration.
string
The unique identifier of the bot to associate with this Telegram integration.
string
The Telegram bot token for authentication. Obtained from BotFather when creating a Telegram bot.
boolean
Whether to enable attachment handling for messages received through this Telegram integration.
string
The ID of the blueprint this Telegram integration is based on or should be updated to use.
string
A description explaining the purpose or configuration of this Telegram integration.
integer
Duration in milliseconds for how long a Telegram conversation session should remain active.
boolean
Whether to enable automatic contact collection from Telegram users.
string
required
The unique identifier of the Telegram integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_TRIGGER_INTEGRATIONTool to update an existing Trigger integration’s configuration. Use when you need to modify Trigger integration settings such as name, description, metadata, associated bot/blueprint, or authentication settings.

Input Parameters

object
Additional metadata to associate with the Trigger integration as key-value pairs.
string
The name of the Trigger integration. This is the display name that identifies the integration.
string
The unique identifier of the bot to associate with this Trigger integration.
string
The ID of the blueprint this Trigger integration is based on or should be updated to use.
string
A description explaining the purpose or configuration of this Trigger integration.
boolean
Whether to enable authentication for this Trigger integration. When true, the trigger will authenticate before executing.
string
required
The unique identifier of the Trigger integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_TWILIO_INTEGRATIONTool to update an existing Twilio integration’s configuration. Use when you need to modify Twilio integration settings such as name, description, session duration, contact collection, or associated bot/blueprint.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the Twilio integration.
string
The ID of the bot to use for this Twilio integration.
string
The ID of the blueprint to associate with this Twilio integration.
string
Updated description explaining the purpose of this Twilio integration.
integer
Session duration in seconds. Controls how long a conversation session remains active.
boolean
Whether to enable contact collection for this Twilio integration.
string
required
The unique identifier of the Twilio integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_WHATS_APP_INTEGRATIONTool to update an existing WhatsApp integration’s configuration. Use when you need to modify WhatsApp integration settings such as access token, phone number ID, session duration, contact collection, or associated bot/blueprint.

Input Parameters

object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the WhatsApp integration.
string
The ID of the bot to use for this WhatsApp integration.
string
The WhatsApp access token for authentication with the WhatsApp Business API.
boolean
Whether to enable attachment support for this WhatsApp integration.
string
The ID of the blueprint to associate with this WhatsApp integration.
string
Updated description explaining the purpose of this WhatsApp integration.
string
The WhatsApp phone number ID associated with this integration.
integer
Session duration in seconds. Controls how long a conversation session remains active.
boolean
Whether to enable contact collection for this WhatsApp integration.
string
required
The unique identifier of the WhatsApp integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPDATE_WIDGET_INTEGRATIONTool to update an existing Widget integration’s configuration. Use when you need to modify widget settings such as title, theme, placeholder text, auto-scroll behavior, or other display and functionality options.

Input Parameters

boolean
Enable form functionality in the widget.
boolean
Enable mathematical notation rendering in the widget.
object
Optional key-value metadata pairs for organizing or tagging the integration.
string
Updated name for the Widget integration.
string
The ID of the bot to use for this Widget integration.
string
Introduction text to display in the widget.
string
Theme for the widget appearance.
string
Title to display in the widget header.
boolean
Enable tools functionality in the widget.
string
Layout style for the widget.
string
Origin URL where the widget is allowed to be embedded.
boolean
Enable streaming responses in the widget.
boolean
Enable link unfurling in messages.
string
Initial message to display when the widget loads.
string
Plugins configuration for the widget.
boolean
Enable verbose mode for detailed logging.
boolean
Enable voice input in the widget.
Enable carousel display for messages in the widget.
string
Language code for the widget interface.
boolean
Start the widget in maximized mode.
boolean
Enable voice output in the widget.
boolean
Display ‘Powered by ChatBotKit’ branding in the widget.
boolean
Enable auto-scrolling to the latest message in the widget.
boolean
Start the conversation immediately when the widget loads.
boolean
Enable file attachments in the widget.
string
The ID of the blueprint to associate with this Widget integration.
string
Updated description explaining the purpose of this Widget integration.
boolean
Enable message peek functionality.
string
Placeholder text for the message input field.
number
Session duration in seconds.
boolean
Enable collection of contact information from users.
boolean
Enable users to export their conversation history.
boolean
Enable users to restart the conversation.
string
required
The unique identifier of the Widget integration to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPLOAD_CONVERSATION_ATTACHMENTUpload a file as a conversation attachment in ChatBotKit. Returns the attachment ID and, when provided, upload details.

Input Parameters

object
required
File to upload as a conversation attachment.
string
required
The unique identifier of the conversation to attach the file to. Obtain this ID from the list_conversations action or when creating a new conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPLOAD_FILETool to upload content to an existing file resource in ChatBotKit. Use when you need to populate a file resource with actual file data.

Input Parameters

object
required
File to upload.
string
required
The unique identifier of the file to upload content to. This ID should be obtained from a file creation action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPSERT_CONVERSATION_CONTACTCreate or update contact information for a ChatBotKit conversation. Use this to associate details such as an email address, phone number, fingerprint, or nickname with the conversation.

Input Parameters

string
The nickname or display name of the contact.
string
The email address of the contact.
string
The phone number of the contact. Must be in E.164 format with separators (e.g., +1-234-567-8900).
string
A unique fingerprint identifier for the contact. Must be at least 16 characters long.
string
required
The unique identifier of the conversation to upsert contact for. Obtain this ID from the list_conversations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPVOTE_BOTTool to upvote a bot in ChatBotKit. Use when you want to endorse or rate a bot positively, providing optional feedback on why the bot deserves recognition.

Input Parameters

string
required
The unique identifier of the bot to upvote. Use the List Bots action to find available bot IDs.
integer
The value of the upvote, ranging from 1 to 100. Defaults to 100 if not specified. Higher values indicate stronger endorsement.
string
Optional reason for upvoting the bot. Provide context for why the bot is being upvoted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPVOTE_CONVERSATIONTool to upvote a conversation in ChatBotKit. Use when you want to endorse or rate a conversation positively, providing optional feedback on quality.

Input Parameters

integer
The value of the upvote, ranging from 1 to 100. Defaults to 100 if not specified. Higher values indicate stronger endorsement.
string
Optional reason for upvoting the conversation. Provide context for why the conversation is being upvoted.
string
required
The unique identifier of the conversation to upvote. Use the List Conversations action to find available conversation IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_UPVOTE_CONVERSATION_MESSAGETool to upvote a conversation message in ChatBotKit. Use when you want to endorse or rate a specific message positively within a conversation.

Input Parameters

integer
The value of the upvote, ranging from 1 to 100. Defaults to 100 if not specified. Higher values indicate stronger endorsement.
string
Optional reason for upvoting the message. Provide context for why the message is being upvoted.
string
required
The unique identifier of the message to upvote. Use List Conversation Messages action to find available message IDs within a conversation.
string
required
The unique identifier of the conversation containing the message to upvote. Use List Conversations action to find available conversation IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATBOTKIT_VERIFY_SECRETTool to verify a secret in ChatBotKit. Use when you need to check the authentication status of a secret credential.

Input Parameters

string
required
The ID of the secret to be verified

Output

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