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 of users, conversations, messages, bots, events, and state within Botpress. Specifically, the Delete User operation allows you to remove a user profile from the Botpress system by specifying the user's ID.

Common scenarios for this node include automating user lifecycle management in chatbots, cleaning up inactive or test users, and integrating user data management into broader workflows. For example, after a user unsubscribes or deletes their account on your platform, you can trigger this node to delete their corresponding Botpress user profile automatically.

Properties

Name Meaning
User ID The unique identifier of the user to delete.
Additional Fields A collection of optional fields that can be used with various operations (not used here).

Note: For the Delete User operation, only the User ID is required and used. The "Additional Fields" property is available but not applicable for deletion.

Output

The output is a JSON object representing the response from the Botpress API after attempting to delete the user. Typically, this will confirm successful deletion or provide error details if the operation failed.

Example output structure:

{
  "json": {
    // API response confirming deletion or error message
  },
  "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 URL, access token, bot ID, and optionally an integration ID.
  • The node sends HTTP requests to the Botpress API endpoints using these credentials and parameters.

Troubleshooting

  • Common issues:

    • Invalid or missing User ID: Ensure the User ID provided exists in Botpress.
    • Authentication errors: Verify that the API key and access token are valid and have sufficient permissions.
    • Network or endpoint errors: Confirm the Botpress API URL is correct and accessible.

  • Error messages:

    • "Unknown user operation: deleteUser": Indicates a misconfiguration or unsupported operation; ensure the operation is set correctly.
    • API error responses will be returned in the output JSON under an error field if the request fails.

  • To resolve errors, check credentials, input parameters, and network connectivity.

Links and References

Discussion