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 providing access to event-related data within conversations. The Get Event operation retrieves detailed information about a specific event in a conversation by its unique event ID.

Typical use cases include:

  • Fetching details of a particular event triggered during a chat session for auditing or analysis.
  • Retrieving event metadata to drive conditional logic or further automation in workflows.
  • Debugging or monitoring conversation flows by inspecting individual events.

For example, you might use this node to get the payload and type of an event that was fired when a user clicked a button or sent a message, enabling your workflow to react accordingly.

Properties

Name Meaning
Event ID The unique identifier of the event to retrieve.
Additional Fields A collection of optional parameters (not used in Get Event operation).

Note: For the Get Event operation, only the Event ID and Conversation ID (required but not listed in your properties JSON) are essential inputs. The node expects the conversation ID as well to locate the event within the correct conversation context.

Output

The node outputs a JSON object representing the event details retrieved from the Botpress API. This includes fields such as:

  • id: The event's unique identifier.
  • type: The type/category of the event.
  • payload: The content or data associated with the event.
  • Other metadata related to the event.

The output is structured as a single item per input, with the event data under the json key.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential and authentication token for the Botpress API.
  • Needs configuration of the Botpress API URL and bot identifiers.
  • The node sends requests through a proxy service (https://n8ntools.io/api/v1/proxy/botpress) using an additional API key for that proxy.

Troubleshooting

  • Error: Unknown event operation — Ensure the operation parameter is set exactly to "getEvent".
  • Error: Missing required parameters — Confirm both the conversation ID and event ID are provided.
  • Authentication errors — Verify that the API credentials (API key, access token) are correctly configured and valid.
  • Event not found — Check that the event ID exists within the specified conversation.
  • JSON parsing errors — If using additional JSON fields elsewhere, ensure they are valid JSON strings.

If the node fails and "Continue On Fail" is disabled, it will throw an error stopping execution; otherwise, it returns an error object in the output.

Links and References

Discussion