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 API, enabling users to manage and interact with bots, conversations, messages, users, events, and state variables within the Botpress conversational AI platform. Specifically, the Bot - List Integrations operation retrieves a list of integrations configured for a particular bot.

Common scenarios where this node is beneficial include:

  • Retrieving all third-party integrations (e.g., Slack, Telegram) connected to a Botpress bot.
  • Auditing or managing integration channels programmatically.
  • Automating workflows that depend on the current set of active integrations for a bot.

For example, you might use this node to fetch all integrations before sending targeted messages through specific channels or to synchronize integration data with other systems.

Properties

Name Meaning
Additional Fields Optional parameters to customize the request; for "List Integrations" operation, no specific additional fields are used here but the collection exists for consistency.

Note: The provided properties JSON includes many fields under "Additional Fields," but for the Bot - List Integrations operation, none of these additional fields are utilized in the API call.

Output

The output is a JSON object representing the response from the Botpress API endpoint /v1/admin/bots/{botId}/integrations. This typically contains an array or list of integration objects associated with the specified bot.

Each integration object may include details such as:

  • Integration channel name (e.g., telegram, slack)
  • Configuration metadata
  • Status or enabled/disabled flags

The exact structure depends on the Botpress API response schema for integrations.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Botpress API.
  • Requires configuration of the Botpress API URL, access token, bot ID, and optionally an integration ID.
  • The node sends requests via a proxy service (https://n8ntools.io/api/v1/proxy/botpress) using an API key for that proxy.
  • Proper permissions on the Botpress API to read bot integrations are necessary.

Troubleshooting

  • Error: Unknown bot operation: listIntegrations
    This error indicates the operation parameter was not correctly set to "listIntegrations" when resource is "bot". Ensure the operation is selected properly.

  • Authentication errors (e.g., 401 Unauthorized)
    Verify that the API key credential and access token are valid and have sufficient permissions.

  • Empty or unexpected response
    Confirm that the bot ID is correct and that the bot has integrations configured.

  • Network or proxy errors
    Since the node uses a proxy endpoint, ensure network connectivity and that the proxy API key is valid.

Links and References

Discussion