N8N Tools - Botpress API icon

N8N Tools - Botpress API

Complete Botpress integration - Enterprise conversational AI with advanced NLP
Join our community

Actions26

Overview

The node enables sending messages to conversations managed by a Botpress conversational AI platform. It supports multiple message types such as text, cards, images, files, videos, audio, carousels, and choice prompts. This flexibility allows users to interact with chatbots or conversational agents in rich and varied formats.

Common scenarios include:

  • Sending simple text replies or notifications.
  • Delivering rich content like cards with images and actions (buttons).
  • Sharing media files such as images, videos, or audio clips.
  • Presenting users with choices or quick reply options to guide conversation flow.

For example, a customer support chatbot could use this node to send a card with product information and action buttons, or an alert system might send a text message notification.

Properties

Name Meaning
Conversation ID The unique identifier of the conversation where the message will be sent.
Message Type The type of message to send. Options: Text, Card, Carousel, Choice, File, Image, Video, Audio.
Message Text Text content of the message (required if Message Type is Text).
Card Title Title of the card (required if Message Type is Card).
Card Subtitle Subtitle of the card (optional for Card type).
Image URL URL of the image (required if Message Type is Image or Card).
File URL URL of the file (required if Message Type is File, Video, or Audio).
Additional Fields A collection of optional fields to enrich the message:
- Tags Comma-separated list of tags for categorization.
- Integration Channel Name of the integration channel (e.g., telegram, slack).
- User Name Display name for the user sending the message.
- User Picture URL Profile picture URL for the user.
- Metadata Additional metadata as a JSON object.
- State Variables State variables as a JSON object related to the conversation.
- Event Type Type of event to create (not directly used in Send Message but available in additional fields).
- Event Payload Event payload as JSON (same note as above).
- Quick Replies Comma-separated list of quick reply options (used for Text and Choice message types).
- Actions JSON array defining card or message actions (buttons, links) for Card messages.
- Limit Maximum number of results to return (not applicable for sending messages).
- Page Token Token for pagination (not applicable for sending messages).

Output

The node outputs the response from the Botpress API call in the json field. This typically contains details about the sent message, including its ID, timestamp, and any server-generated metadata confirming successful delivery.

If the message includes media (file, image, video, audio), the output confirms the upload or link status but does not output binary data itself.

Dependencies

  • Requires an API key credential and access token for authenticating with the Botpress API.
  • Needs the base URL of the Botpress API instance.
  • Requires the bot ID to specify which bot the message relates to.
  • Optionally uses an integration ID header if specified.

These credentials and configuration must be set up in n8n prior to using the node.

Troubleshooting

  • Invalid Conversation ID: If the conversation ID is incorrect or does not exist, the API will return an error. Verify the conversation ID before sending.
  • Missing Required Fields: For each message type, required fields must be provided (e.g., messageText for text messages, cardTitle and imageUrl for card messages). Omitting these will cause errors.
  • Malformed JSON in Additional Fields: Fields like metadata, stateVariables, and actions expect valid JSON. Invalid JSON syntax will cause parsing errors.
  • Authentication Errors: Ensure that the API key, access token, and bot ID are correctly configured and have sufficient permissions.
  • Unsupported Message Type: Using a message type not supported by the node will throw an error.
  • Quick Replies Formatting: Quick replies must be comma-separated strings; improper formatting may lead to unexpected behavior.

Links and References

This summary covers the "Send Message" operation of the "Message" resource based on the provided source code and property definitions.

Discussion