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 "List Users" operation retrieves a list of user profiles from the Botpress system. This is useful for scenarios where you want to fetch and process user data such as names, profile pictures, tags, or metadata in workflows that involve user management, analytics, or personalized messaging.

Practical examples include:

  • Fetching all users to analyze engagement or segment them by tags.
  • Retrieving paginated user lists to synchronize with external CRM systems.
  • Using user data to trigger targeted notifications or follow-up conversations.

Properties

Name Meaning
Additional Fields Collection of optional parameters to refine the user list query:
- Tags Comma-separated list of tags to filter users by specific labels.
- Integration Channel Name of the integration channel (e.g., telegram, slack) to filter users by source.
- User Name Display name filter for users.
- User Picture URL Filter or specify profile picture URL for users.
- Metadata Additional metadata as a JSON object to filter or enrich user data.
- State Variables State variables as a JSON object related to users.
- Event Type Type of event to create (not applicable for listing users but part of additional fields).
- Event Payload Event payload as JSON (not applicable here).
- Quick Replies Comma-separated quick reply options (not applicable here).
- Actions Card/message actions as a JSON array (not applicable here).
- Limit Maximum number of user results to return (default 100).
- Page Token Token for pagination to retrieve the next set of users.

Output

The output is an array of JSON objects representing the users retrieved from the Botpress API. Each item corresponds to one user and includes all user-related data returned by the API, such as user ID, name, profile picture URL, tags, metadata, and any other user attributes.

The node does not output binary data.

Example output structure snippet (simplified):

[
  {
    "id": "user123",
    "name": "John Doe",
    "pictureUrl": "https://example.com/johndoe.jpg",
    "tags": ["premium", "beta-tester"],
    "metadata": { "customField": "value" }
  },
  ...
]

Dependencies

  • Requires an API key credential and access token for authenticating with the Botpress API.
  • Needs the base URL of the Botpress API instance.
  • The node uses HTTP requests to communicate with the Botpress API endpoints.
  • No additional external services are required beyond the Botpress API itself.

Troubleshooting

  • Common issues:

    • Invalid or expired API tokens will cause authentication failures.
    • Incorrect or missing pagination tokens may result in incomplete user lists.
    • Providing malformed JSON in metadata or state variables fields can cause request errors.
    • Exceeding the limit parameter beyond allowed maximums might be rejected by the API.

  • Error messages:

    • "Unknown user operation": Indicates an unsupported operation was selected; ensure "List Users" is chosen.
    • HTTP 401 Unauthorized: Check API credentials and tokens.
    • JSON parse errors: Validate JSON input fields like metadata before running the node.

  • Resolutions:

    • Verify and refresh API credentials if authentication fails.
    • Use valid JSON syntax in JSON-type fields.
    • Use pagination tokens correctly to navigate through large user lists.
    • Adjust the limit parameter to reasonable values supported by the API.

Links and References

Discussion