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 to manage users and their profiles within a conversational AI environment. Specifically, the "Get User" operation retrieves detailed information about a single user by their unique user ID.

Use cases include:

  • Fetching user profile details for personalization in chatbots.
  • Retrieving metadata or tags associated with a user to tailor conversation flows.
  • Accessing integration-specific user data (e.g., from Telegram or Slack).
  • Obtaining user picture URLs or state variables for enhanced UI/UX.

Practical example: A chatbot workflow that needs to display user information before continuing a conversation can use this node to fetch the user's profile data dynamically.

Properties

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

For the "Get User" operation, only the User ID is required; other additional fields are generally not used but available for consistency across operations.

Output

The node outputs a JSON object containing the user details retrieved from the Botpress API endpoint /v1/chat/users/{userId}.

Typical output structure includes:

  • User ID
  • Name (display name)
  • Picture URL
  • Tags (array)
  • Metadata (JSON object)
  • State variables (JSON object)
  • Integration channel info (if any)
  • Other user profile attributes as provided by the Botpress API

No binary data output is produced 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 HTTP requests to the Botpress API via a proxy service hosted at https://n8ntools.io/api/v1/proxy/botpress.
  • Proper permissions on the Botpress API to read user data are necessary.

Troubleshooting

  • Error: Unknown user operation — Ensure the operation parameter is set exactly to "getUser".
  • Authentication errors — Verify that the API key, access token, and bot ID credentials are correctly configured and valid.
  • User not found — Confirm the User ID exists in the Botpress system.
  • Invalid JSON in additional fields — If using JSON fields like metadata or stateVariables, ensure they are well-formed JSON strings.
  • Network or proxy issues — Check connectivity to the proxy URL and that the API key for the proxy service is valid.

Links and References

Discussion