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 providing functionality to list conversations within a Botpress bot instance. It allows users to retrieve multiple conversation records, supporting pagination and limiting the number of results returned.

Common scenarios where this node is beneficial include:

  • Monitoring active or past chat sessions handled by a Botpress bot.
  • Extracting conversation data for analytics or reporting.
  • Feeding conversation lists into workflows that perform further processing or automation based on conversation metadata.

For example, you could use this node to fetch the latest 100 conversations from your Botpress bot and then filter or analyze them in subsequent workflow steps.

Properties

Name Meaning
Additional Fields A collection of optional parameters to refine the listing:
- Tags Comma-separated list of tags to filter conversations by specific labels.
- Integration Channel The name of the integration channel (e.g., telegram, slack) to filter conversations.
- User Name Display name of the user associated with the conversations (filter).
- User Picture URL Profile picture URL of the user (filter).
- Metadata Additional metadata as a JSON object to filter conversations.
- State Variables State variables as a JSON object to filter conversations.
- Event Type Type of event to create (not applicable for listing but part of additional fields).
- Event Payload Event payload as JSON (not applicable for listing).
- Quick Replies Comma-separated list of quick reply options (not applicable for listing).
- Actions Card/message actions as a JSON array (not applicable for listing).
- Limit Maximum number of conversation results to return (default 100).
- Page Token Token for pagination to retrieve the next page of results.

Output

The output is an array of JSON objects representing conversations retrieved from the Botpress API. Each item corresponds to one conversation record and includes all available conversation details as provided by the Botpress backend.

The structure of each conversation JSON object depends on the Botpress API response but typically includes identifiers, user info, tags, metadata, state variables, and timestamps.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Botpress API.
  • Needs configuration of the Botpress API base URL, access token, bot ID, and optionally an integration ID.
  • The node sends requests through a proxy service at https://n8ntools.io/api/v1/proxy/botpress using an API key for that proxy.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect bot ID or integration ID may result in "resource not found" errors.
    • Pagination tokens must be used correctly; invalid tokens can cause empty or error responses.
    • Providing malformed JSON in additional fields like metadata or stateVariables will cause parsing errors.

  • Error messages:

    • "Unknown conversation operation: listConversations" indicates a misconfiguration of the operation parameter.
    • HTTP 401 Unauthorized errors suggest invalid or expired API tokens.
    • JSON parse errors when specifying JSON fields mean the input is not valid JSON syntax.

  • Resolutions:

    • Verify and update API credentials and bot configuration.
    • Ensure JSON inputs are well-formed.
    • Use the limit and nextToken fields properly for paginated results.

Links and References

Discussion