N8N Tools - Botpress API icon

N8N Tools - Botpress API

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

Actions26

Overview

This node integrates with the Botpress conversational AI platform, specifically enabling interaction with messages within conversations. The Get Message operation retrieves detailed information about a specific message in a conversation by its ID.

Typical use cases include:

  • Fetching the content and metadata of a particular message for auditing or display purposes.
  • Retrieving message details to trigger further processing or analytics.
  • Integrating Botpress message data into other workflows or systems.

For example, you might use this node to get the text and metadata of a user’s message in a chatbot conversation to analyze user intent or log interactions.

Properties

Name Meaning
Message ID The unique identifier of the message to retrieve.
Additional Fields Optional extra parameters to refine the request:
- Tags Comma-separated list of tags (not used in Get Message but available for other operations).
- Integration Channel Name of the integration channel (e.g., telegram, slack).
- User Name Display name for the user associated with the message.
- User Picture URL URL of the user's profile picture.
- Metadata Additional metadata as a JSON object.
- State Variables State variables as a JSON object.
- Event Type Type of event to create (not applicable for Get Message).
- Event Payload Event payload as JSON (not applicable for Get Message).
- Quick Replies Comma-separated list of quick reply options (not applicable for Get Message).
- Actions Card/message actions as a JSON array (not applicable for Get Message).
- Limit Maximum number of results to return (not applicable for Get Message).
- Page Token Token for pagination (not applicable for Get Message).

Note: For the Get Message operation, only the Message ID and Conversation ID (required input not listed here but used in code) are essential. Additional fields are generally unused in this operation.

Output

The output is a JSON object representing the retrieved message details from the Botpress API. This includes:

  • Message content (text, card, image, file, etc.).
  • Metadata associated with the message.
  • User information related to the message.
  • Any additional properties returned by the Botpress API for that message.

The structure directly reflects the Botpress message schema, typically including fields like id, type, payload, userId, createdAt, and any custom metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Botpress API credential with:

    • An API key.
    • API base URL.
    • Access token.
    • Bot ID.
    • Optionally, an integration ID.

  • The node makes authenticated HTTP requests to the Botpress API endpoints.

  • No additional external dependencies beyond the Botpress API and n8n's HTTP request helper.

Troubleshooting

  • Common Issues:

    • Invalid or missing Message ID or Conversation ID will cause errors.
    • Incorrect or expired API credentials will result in authentication failures.
    • Network connectivity issues may prevent reaching the Botpress API.

  • Error Messages:

    • "Unknown resource: message" or "Unknown message operation: getMessage" indicates misconfiguration of resource or operation parameters.
    • Authentication errors typically mention invalid tokens or unauthorized access.
    • JSON parsing errors may occur if malformed JSON is provided in additional fields (though not typical for Get Message).

  • Resolutions:

    • Verify that the Message ID and Conversation ID are correct and exist in the Botpress system.
    • Ensure API credentials are valid and have necessary permissions.
    • Check network connectivity and API endpoint accessibility.
    • Use the "Continue On Fail" option in n8n to handle errors gracefully in workflows.

Links and References

Discussion