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 interaction with conversations and messages. The Send Typing Indicator operation under the Message resource allows you to send a typing indicator event to a specified conversation. This is useful for simulating that a bot or user is actively typing a response, enhancing the conversational experience by providing real-time feedback.

Common scenarios:

  • Indicating to users that the bot is processing their input before sending a reply.
  • Creating more natural chat interactions in messaging platforms integrated with Botpress.
  • Improving user engagement by showing typing status during longer processing times.

Practical example:
You have a chatbot connected via Botpress, and when a user sends a message, you want to show a typing indicator for a few seconds before the bot replies. Using this node operation, you can trigger the typing indicator on the conversation to simulate the bot "typing."

Properties

Name Meaning
Conversation ID The unique identifier of the conversation where the typing indicator will be sent.
Additional Fields Optional extra parameters including:
- Tags Comma-separated list of tags (not used directly in this operation but available).
- Integration Channel Name of the integration channel (e.g., telegram, slack).
- User Name Display name for the user (optional metadata).
- User Picture URL Profile picture URL for the user (optional metadata).
- Metadata Additional metadata as JSON object (optional).
- State Variables State variables as JSON object (optional).
- Event Type Type of event to create (not applicable here).
- Event Payload Event payload as JSON (not applicable here).
- Quick Replies Comma-separated list of quick reply options (not applicable here).
- Actions Card/message actions as JSON array (not applicable here).
- Limit Maximum number of results to return (not applicable here).
- Page Token Token for pagination (not applicable here).

For the Send Typing Indicator operation, the only required property is Conversation ID. The User ID is also included in the request body if provided, though it is optional.

Output

The output is a JSON object representing the response from the Botpress API after sending the typing indicator. It typically confirms the success of the operation or provides error details if the request failed.

The structure is:

{
  "json": {
    // Response data from Botpress API about the typing indicator event
  }
}

No binary data is involved in this operation.

Dependencies

  • Requires an active Botpress API credential with:
    • An API key credential for authentication.
    • Access token for Bearer authorization.
    • Bot ID to specify which bot instance to interact with.
  • The node makes HTTP requests to the Botpress API endpoint configured in the credentials.
  • Optionally supports specifying an integration ID header if using integrations.

Troubleshooting

  • Error: Unknown message operation: sendTyping
    Ensure the operation selected is exactly "Send Typing Indicator" under the Message resource.

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

  • Invalid Conversation ID
    Confirm the conversation ID exists and is active in your Botpress environment.

  • Network or Proxy issues
    The node uses a proxy service (https://n8ntools.io/api/v1/proxy/botpress) to forward requests. Network restrictions or proxy downtime may cause failures.

  • Malformed additional fields
    If using JSON fields like metadata, ensure valid JSON syntax to avoid parsing errors.

Links and References

Discussion