Tool to send a message to an existing Botpress conversation via the Runtime API. Use when you need to create and deliver a message to a user.
tagsobjectKey-value pairs for message categorization. Keys are limited to 500 characters.
typeRequiredstringMessage resource type (max 200 characters). Typically 'text' for text messages.
botIdRequiredstringUUID of the bot to send the message for. This is passed as the x-bot-id header.
originstringMessage origin. Only 'synthetic' is supported as a value.
userIdRequiredstringUnique identifier of the user sending or receiving the message (28-36 characters). Must be obtained from getOrCreateUser endpoint.
payloadRequiredobjectMessage content object. For text messages, use {'text': 'your message'}. Supports Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location.
scheduleobjectConfiguration for scheduling message delivery.
conversationIdRequiredstringUnique identifier of the conversation (28-36 characters). Must be obtained from getOrCreateConversation or list conversations endpoints.
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.