N8N Tools - Botpress API
Actions26
- Bot Actions
- Conversation Actions
- Message Actions
- User Actions
- Event Actions
- State Actions
Overview
This node integrates with the Botpress API, enabling users to manage and interact with bots, conversations, messages, users, events, and state variables within the Botpress conversational AI platform. Specifically, the Get Bot Info operation under the Bot resource retrieves detailed information and configuration about a specific bot.
Typical use cases include:
- Fetching current bot settings and metadata for monitoring or auditing.
- Integrating bot details into workflows that require dynamic bot information.
- Automating bot management tasks by retrieving bot info before updates or analytics.
For example, a user might use this node to get the configuration of a chatbot deployed on Botpress to verify its active integrations or tags before sending targeted messages.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional extra parameters to customize the request; includes: |
| - Tags | Comma-separated list of tags |
| - Integration Channel | Name of the integration channel (e.g., telegram, slack) |
| - User Name | Display name for the user |
| - User Picture URL | Profile picture URL for the user |
| - Metadata | Additional metadata as JSON |
| - State Variables | State variables as a JSON object |
| - Event Type | Type of event to create |
| - Event Payload | Event payload as JSON |
| - Quick Replies | Comma-separated list of quick reply options |
| - Actions | Card/message actions as a JSON array |
| - Limit | Maximum number of results to return |
| - Page Token | Token for pagination |
Note: For the Get Bot Info operation, no additional fields are required or typically used, but the property is available for consistency across operations.
Output
The node outputs a JSON object containing the response from the Botpress API endpoint /v1/admin/bots/{botId}. This JSON includes detailed information about the bot such as its configuration, metadata, integrations, and status.
Output structure highlights:
json: The main field containing the bot information returned by the API.pairedItem: References the input item index for traceability in workflows.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the Botpress API.
- Needs the Botpress API base URL, access token, and bot ID configured in the node credentials.
- The node sends requests through a proxy service (
https://n8ntools.io/api/v1/proxy/botpress) using an API key for that proxy.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect bot ID will result in "not found" errors.
- Network or proxy issues may prevent successful API calls.
Error messages:
"Unknown bot operation: getBotInfo": Indicates a misconfiguration of the operation parameter.- HTTP 401 Unauthorized: Check API key and access token validity.
- HTTP 404 Not Found: Verify the bot ID exists and is accessible.
Resolutions:
- Ensure all required credentials and parameters are correctly set.
- Confirm the bot ID corresponds to an existing bot in your Botpress instance.
- Test connectivity to the proxy and Botpress API endpoints outside n8n if needed.