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 within a conversational AI platform. Specifically, the "Update User" operation allows updating user profile information such as display name, profile picture URL, and tags associated with the user.

Common scenarios where this node is beneficial include:

  • Synchronizing user profile updates from external systems into Botpress.
  • Enriching user profiles with additional metadata or tags for personalized conversational experiences.
  • Maintaining up-to-date user information in chatbot applications.

For example, you can update a user's display name and profile picture after they change their details in your CRM system, ensuring the chatbot addresses them correctly.

Properties

Name Meaning
User ID The unique identifier of the user to update (required).
Additional Fields Optional fields to update on the user profile:
- Tags Comma-separated list of tags to associate with the user.
- Integration Channel Name of the integration channel (e.g., telegram, slack).
- User Name Display name for the user.
- User Picture URL URL of the user's profile picture.
- Metadata Additional metadata as a JSON object (stringified JSON).
- State Variables State variables as a JSON object (stringified JSON).
- Event Type Type of event to create (not typically used in update user).
- Event Payload Event payload as JSON (not typically used in update user).
- Quick Replies Comma-separated list of quick reply options (not typically used in update user).
- Actions Card/message actions as a JSON array (not typically used in update user).
- Limit Maximum number of results to return (not typically used in update user).
- Page Token Token for pagination (not typically used in update user).

Note: For the "Update User" operation, only User Name, User Picture URL, and Tags are actually used to update the user profile.

Output

The node outputs the JSON response returned by the Botpress API after attempting to update the user. This typically includes the updated user object with its properties reflecting the changes made.

The output structure is:

{
  "json": {
    // Botpress API response for the updated user
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Botpress API.
  • Requires 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

  • Invalid User ID: If the provided User ID does not exist, the API will likely return an error indicating the user was not found. Verify the User ID is correct.
  • Malformed JSON in Metadata or State Variables: If the JSON strings provided in metadata or stateVariables are invalid, the node will throw a parsing error. Ensure these fields contain valid JSON.
  • Authentication Errors: If the API key or access token is missing or invalid, authentication errors will occur. Confirm credentials are properly configured.
  • Unknown Operation or Resource: The node throws errors if an unsupported operation or resource is specified. Make sure to select "User" as resource and "Update User" as operation.
  • Network Issues: Connectivity problems to the Botpress API or proxy endpoint may cause request failures. Check network connectivity and proxy availability.

Links and References

Discussion