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 provides integration with the Botpress conversational AI platform, enabling management and interaction with bots, conversations, messages, users, events, and state variables. Specifically, the Update Bot operation allows updating the configuration of a bot by sending partial updates to its metadata.

Common scenarios for using this node include:

  • Automating bot configuration updates such as changing metadata or tags.
  • Integrating Botpress bot management into broader workflows.
  • Dynamically adjusting bot settings based on external triggers or data.

For example, you might use this node to update a bot's metadata JSON to add new capabilities or change its behavior without manual intervention in the Botpress admin interface.

Properties

Name Meaning
Additional Fields Collection of optional fields to update bot configuration. Includes:
- Tags Comma-separated list of tags associated with the bot.
- Integration Channel Name of the integration channel (e.g., telegram, slack).
- User Name Display name for the user (if applicable).
- User Picture URL URL for the user's profile picture.
- Metadata JSON object containing additional metadata to update the bot configuration.
- State Variables JSON object representing state variables (not typically used in Update Bot).
- Event Type Type of event to create (not used in Update Bot).
- Event Payload JSON payload for an event (not used in Update Bot).
- Quick Replies Comma-separated quick reply options (not used in Update Bot).
- Actions JSON array of card/message actions (not used in Update Bot).
- Limit Maximum number of results to return (not used in Update Bot).
- Page Token Token for pagination (not used in Update Bot).

For the Update Bot operation, the primary relevant property is Metadata, which should be a valid JSON string representing the partial bot configuration updates.

Output

The node outputs the response from the Botpress API as JSON under the json field. This typically contains the updated bot information or confirmation of the update operation.

Example output structure:

{
  "id": "bot-id",
  "name": "Bot Name",
  "metadata": {
    // Updated metadata fields here
  },
  "tags": ["tag1", "tag2"],
  ...
}

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Invalid JSON in Metadata: If the metadata JSON is malformed, the node will throw an error. Ensure the JSON string in the Metadata field is valid.
  • Authentication Errors: Missing or invalid API keys or tokens will cause authorization failures. Verify credentials are correctly set up.
  • Unknown Operation Error: If the operation name is incorrect or unsupported, the node throws an error indicating an unknown operation.
  • Network or Proxy Issues: Since requests go through an external proxy, network issues or proxy downtime can cause failures.
  • Partial Updates: The update uses HTTP PATCH; ensure only intended fields are included in the metadata to avoid overwriting other configurations unintentionally.

Links and References

Discussion