Tool 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 interaction…
metaobjectOptional key-value metadata pairs for organizing or tagging the integration.
namestringA human-readable name for the Extract integration.
botIdRequiredstringThe unique identifier of the bot to attach this Extract integration to. Use the List Bots action to find available bot IDs.
modelstringOptional AI model to use for data extraction. If not specified, uses the default model.
schemaRequiredobjectA 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.
requestOptional 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.
blueprintIdstringOptional ID of the blueprint to associate with this integration.
descriptionstringOptional description explaining the purpose of this Extract integration.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.