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 API to manage messages within conversations. Specifically, the Delete Message operation allows users to delete a specific message from a conversation by providing the conversation ID and the message ID.

Common scenarios where this node is beneficial include:

  • Moderation workflows where inappropriate or outdated messages need to be removed.
  • Automated cleanup of messages after certain triggers or time periods.
  • Managing message lifecycle in customer support or chatbot interactions.

For example, you might use this node to delete a message that contains sensitive information accidentally sent in a chat, or to remove system-generated messages once they are no longer relevant.

Properties

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

Note: For the Delete Message operation, only the Message ID and Conversation ID (required by the node but not listed here as it is a general parameter) are essential. Additional fields are generally unused in this operation.

Output

The output is a JSON object representing the response from the Botpress API after attempting to delete the specified message. Typically, for a successful deletion, the API returns confirmation or an empty success response.

If the deletion fails, the output will contain an error message describing the failure.

No binary data is produced by this operation.

Example output structure:

{
  "json": {
    // API response confirming deletion or error details
  }
}

Dependencies

  • Requires an active Botpress API credential with:
    • An API key credential.
    • Access token for authorization.
    • Bot ID to specify which bot instance to operate on.
  • The node sends requests to the configured Botpress API URL.
  • The node uses an internal proxy service (https://n8ntools.io/api/v1/proxy/botpress) to forward requests.

Troubleshooting

  • Error: Unknown resource or operation
    Ensure the Resource is set to "Message" and Operation to "Delete Message".

  • Authentication errors
    Verify that the API key, access token, and bot ID credentials are correctly configured and valid.

  • Message not found or already deleted
    Confirm that the provided Message ID and Conversation ID are correct and that the message exists.

  • Network or proxy errors
    Check network connectivity and that the proxy endpoint is reachable.

  • Invalid JSON in additional fields
    Although additional fields are not used in delete, if any JSON fields are provided, ensure they are well-formed.

Links and References

Discussion