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 conversational AI platform, specifically managing conversation state variables. The Delete State operation removes all state variables associated with a given conversation. This is useful when you want to reset or clear the stored context or session data for a conversation, effectively starting fresh without any previous state influencing the bot's behavior.

Common scenarios:

  • Clearing user session data after a conversation ends.
  • Resetting conversation context to handle errors or unexpected flows.
  • Managing privacy by deleting sensitive state information once it is no longer needed.

Example:
You have a chatbot that stores user preferences during a session. When the user finishes or cancels the interaction, you use this node’s Delete State operation to clear those preferences from the conversation state.

Properties

Name Meaning
Conversation ID The unique identifier of the conversation whose state variables you want to delete.
Additional Fields (Not used in Delete State operation)

Output

The output JSON contains the response from the Botpress API after attempting to delete the state variables. Typically, this will be an empty object or confirmation message indicating successful deletion.

Output structure example:

{}

If an error occurs, the output JSON will contain an error field with the error message.

Dependencies

  • Requires an API key credential and authentication token for Botpress API access.
  • Needs configuration of:
    • Botpress API URL
    • Bot ID
    • Access token (Bearer token)
    • Optionally, an integration ID if using specific integration channels.

These credentials must be set up in n8n prior to using this node.

Troubleshooting

  • Error: Unknown state operation: deleteState
    Ensure the operation parameter is correctly set to "deleteState" and the resource is "state".

  • Authentication errors (401 Unauthorized)
    Verify that the API key, access token, and bot ID are correctly configured and valid.

  • Invalid Conversation ID
    Confirm that the provided Conversation ID exists and is correct; otherwise, the API will return an error.

  • Network or API endpoint issues
    Check the Botpress API URL configuration and network connectivity.

Links and References

Discussion