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 "Create User" operation allows you to create a new user profile in the Botpress system by providing details such as display name, profile picture URL, tags, and other metadata.

Common scenarios where this node is beneficial include:

  • Automatically registering new users interacting with your chatbot.
  • Syncing user data from external systems into Botpress.
  • Enriching user profiles with additional information like tags or integration channel names.

For example, you could use this node to create a user when someone signs up on your website, passing their name, profile picture URL, and tags to personalize chatbot interactions.

Properties

Name Meaning
Additional Fields A collection of optional fields to enrich the user profile:
- Tags Comma-separated list of tags associated with the user.
- Integration Channel Name of the integration channel (e.g., telegram, slack) through which the user interacts.
- User Name Display name for the user.
- User Picture URL URL pointing to the user's profile picture.
- Metadata Additional metadata as a JSON object to store custom user information.
- State Variables State variables as a JSON object related to the user.
- Event Type Type of event to create (not typically used in user creation).
- Event Payload Event payload as JSON (not typically used in user creation).
- Quick Replies Comma-separated list of quick reply options (not typically used in user creation).
- Actions Card/message actions as a JSON array (not typically used in user creation).
- Limit Maximum number of results to return (not applicable for user creation).
- Page Token Token for pagination (not applicable for user creation).

Note: For the "Create User" operation, only some of these fields are relevant—primarily User Name, User Picture URL, and Tags.

Output

The node outputs a JSON object representing the response from the Botpress API after creating the user. This typically includes the newly created user's details such as their unique ID, name, picture URL, tags, and any other metadata stored.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "pictureUrl": "string",
  "tags": ["tag1", "tag2"],
  "metadata": { /* custom metadata */ }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active Botpress API credential with:
    • An API key.
    • The Botpress API base URL.
    • An access token for authorization.
    • The bot ID to specify which bot the user belongs to.
  • The node sends requests via a proxy service (https://n8ntools.io/api/v1/proxy/botpress) using the provided API key for authentication.
  • Proper configuration of these credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing malformed JSON in metadata or other JSON fields will result in parsing errors.
    • Omitting required fields like User Name may cause the API to reject the request.
    • Network issues or proxy service downtime can prevent the node from reaching the Botpress API.

  • Error Messages:

    • "Unknown user operation: createUser": Indicates a misconfiguration or typo in the operation parameter.
    • Authentication errors usually mention invalid tokens or unauthorized access.
    • JSON parsing errors occur if JSON fields are not properly formatted.

  • Resolutions:

    • Verify all credential fields and ensure they are current and valid.
    • Validate JSON inputs before running the node.
    • Ensure required fields are filled.
    • Check network connectivity and proxy service status.

Links and References

Discussion