N8N Tools - Botpress API icon

N8N Tools - Botpress API

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

Actions26

Overview

The "Update Conversation" operation in this node allows you to modify properties of an existing conversation within a Botpress-powered conversational AI system. This is useful for updating metadata, tags, or other custom attributes associated with a conversation to better reflect its current state or context.

Common scenarios include:

  • Adding or modifying tags to categorize conversations.
  • Updating metadata to store additional information relevant to the conversation.
  • Adjusting state variables that influence conversation flow or user experience.

For example, you might update a conversation to add a tag like "priority" or to attach metadata indicating the user's subscription level.

Properties

Name Meaning
Conversation ID The unique identifier of the conversation to update.
Additional Fields A collection of optional fields to update on the conversation:
- Tags Comma-separated list of tags to assign to the conversation (e.g., "support,urgent").
- Integration Channel Name of the integration channel (e.g., telegram, slack) — not typically used in update.
- User Name Display name for the user associated with the conversation (not commonly updated here).
- User Picture URL URL of the user's profile picture (rarely updated in this operation).
- Metadata JSON object containing additional metadata to associate with the conversation.
- State Variables JSON object representing state variables related to the conversation.
- Event Type Type of event to create (not applicable for update conversation).
- Event Payload JSON payload for an event (not applicable here).
- Quick Replies Comma-separated quick reply options (not applicable here).
- Actions JSON array of card/message actions (not applicable here).
- Limit Maximum number of results to return (not applicable here).
- Page Token Token for pagination (not applicable here).

Note: For this operation, only Tags and Metadata are actively used in the update request body. Tags are split into an array by commas and trimmed. Metadata is parsed from JSON string input.

Output

The output is a JSON object representing the updated conversation as returned by the Botpress API. It includes all conversation details after the update, such as:

  • Conversation ID
  • Updated tags array
  • Updated metadata object
  • Other conversation properties managed by Botpress

No binary data is output by this operation.

Dependencies

  • Requires an API key credential and access token for authenticating with the Botpress API.
  • Needs the Botpress API base URL and bot ID configured in the node credentials.
  • The node sends requests to the Botpress API via a proxy service hosted at https://n8ntools.io/api/v1/proxy/botpress using an additional API key for that proxy.

Troubleshooting

  • Invalid Conversation ID: If the conversation ID does not exist or is incorrect, the API will return an error. Verify the ID before running the node.
  • Malformed Metadata JSON: The metadata field must be valid JSON. Invalid JSON will cause parsing errors. Use a JSON validator to check your input.
  • Tags Format: Tags should be comma-separated strings without extra spaces; otherwise, they may not be processed correctly.
  • Authentication Errors: Ensure the API key and access token are valid and have sufficient permissions to update conversations.
  • API Endpoint Errors: If the Botpress API URL or bot ID is misconfigured, requests will fail. Double-check credentials configuration.

Links and References

Discussion