N8N Tools - Botpress API icon

N8N Tools - Botpress API

Complete Botpress integration - Enterprise conversational AI with advanced NLP
Join our community

Actions26

Overview

The node integrates with the Botpress conversational AI platform, specifically enabling management and retrieval of conversation data. The Get Conversation operation fetches detailed information about a specific conversation by its ID. This is useful for scenarios where you want to analyze or process the state and metadata of an ongoing or past chat session within Botpress.

Practical examples include:

  • Retrieving conversation context to personalize follow-up messages.
  • Auditing conversation history for quality assurance.
  • Integrating conversation details into CRM or support ticketing systems.

Properties

Name Meaning
Conversation ID The unique identifier of the conversation to retrieve.
Additional Fields A collection of optional parameters that can be added for other operations but are not used in this operation.

Note: For the Get Conversation operation, only the Conversation ID is required and used.

Output

The output is a JSON object representing the full details of the requested conversation as returned by the Botpress API. This typically includes:

  • Conversation metadata (e.g., tags, integration channel).
  • User information linked to the conversation.
  • Conversation state and variables.
  • Timestamps and status.
  • Any additional custom fields stored in the conversation.

No binary data is output by this operation.

Example output structure (simplified):

{
  "id": "string",
  "userId": "string",
  "tags": ["tag1", "tag2"],
  "integrationName": "string",
  "metadata": { /* custom metadata */ },
  "stateVariables": { /* state data */ },
  "createdAt": "timestamp",
  "updatedAt": "timestamp"
}

Dependencies

  • Requires an API key credential for authenticating with the Botpress API.
  • Needs the Botpress API URL endpoint configured.
  • Requires a valid access token and bot identifier.
  • Optionally uses an integration ID if interacting via a specific integration channel.

These credentials and configuration must be set up in n8n prior to using the node.

Troubleshooting

  • Error: Unknown conversation operation
    Occurs if an unsupported operation name is provided. Ensure the operation is exactly "getConversation".

  • Error: Missing Conversation ID
    The conversation ID parameter is mandatory. Verify it is correctly set and passed.

  • Authentication errors
    Check that the API key, access token, and bot ID are valid and have sufficient permissions.

  • Network or API endpoint errors
    Confirm the Botpress API URL is reachable and correct.

  • JSON parsing errors on metadata or state variables
    If additional fields are used elsewhere, ensure JSON strings are well-formed.

Links and References

Discussion