N8N Tools - Botpress API

Complete Botpress integration - Enterprise conversational AI with advanced NLP and multi-channel deployment.

Features

• Enterprise AI: Advanced conversational AI with built-in NLP capabilities
• Multi-Channel Deployment: Websites, Facebook, Instagram, WhatsApp, Telegram, Slack
• Visual Flow Builder: Drag-and-drop conversation design with code flexibility
• Knowledge Agents: AI-powered responses from custom knowledge bases
• Sentiment Analysis: Real-time emotion detection and response adaptation
• User Management: Complete user profiles, properties, and conversation tracking
• Event System: Custom events and triggers for advanced workflow automation
• State Management: Persistent conversation variables and context

Installation

npm install n8n-nodes-n8ntools-botpress-api

Credentials

Configure Botpress API credentials in N8N:

1. N8N Tools API Key: Your N8N Tools API key for billing and usage tracking
   • Get it from: N8N Tools Dashboard - API Keys
   • Required for all operations (enables credit-based billing)
2. API URL: Botpress API endpoint
   • Cloud: https://api.botpress.cloud
   • Self-hosted: https://your-botpress-instance.com
3. Access Token: Choose token type based on use case:
   • PAT (Personal Access Token): Full account access
   • BAK (Bot Access Key): Bot-specific operations only
   • IAK (Integration Access Key): Integration-specific access
4. Bot ID: Your Botpress bot identifier
5. Integration ID: Required only for integration-specific operations

Credit System

This node operates on N8N Tools' credit-based billing system:

• API Calls: 1 credit per basic API request
• Message Operations: 2 credits per message sent/received
• AI Operations: 3-5 credits per AI-powered interaction
• Bulk Operations: Credits scale with data processed
• Real-time Tracking: Monitor usage in your N8N Tools dashboard

All requests are securely proxied through N8N Tools infrastructure for billing, monitoring, and enhanced reliability.

Operations

Bot Management

• Get Bot Info: Retrieve bot configuration and metadata
• Update Bot: Modify bot settings and properties
• Get Bot Statistics: Usage analytics and performance metrics
• List Integrations: Available integrations and channels

Conversation Operations

• List Conversations: Get all conversations with pagination
• Get Conversation: Retrieve specific conversation details
• Create Conversation: Start new conversations with users
• Update Conversation: Modify conversation properties and tags
• Delete Conversation: Remove conversations permanently

Message Management

• Send Message: Send various message types (text, cards, files)
• Get Message: Retrieve specific message details
• Update Message: Modify message metadata
• Delete Message: Remove messages from conversations
• Send Typing: Display typing indicators

User Management

• List Users: Get all users with filtering options
• Get User: Retrieve specific user information
• Create User: Register new users in the system
• Update User: Modify user profiles and properties
• Delete User: Remove users from the system

Event System

• List Events: Get conversation events and triggers
• Create Event: Generate custom events for workflows
• Get Event: Retrieve specific event details

State Management

• Get State: Retrieve conversation variables
• Set State: Update conversation context and variables
• Delete State: Clear conversation state

Usage Examples

Send Text Message

{
  "resource": "message",
  "operation": "sendMessage",
  "conversationId": "conv-123-abc",
  "messageType": "text",
  "messageText": "Hello! How can I help you today?",
  "userId": "user-456"
}

Send Interactive Card

{
  "resource": "message",
  "operation": "sendMessage",
  "conversationId": "conv-123-abc",
  "messageType": "card",
  "cardTitle": "Product Information",
  "cardSubtitle": "Learn more about our services",
  "imageUrl": "https://example.com/product.jpg",
  "additionalFields": {
    "actions": [
      {"type": "button", "title": "Learn More", "value": "learn_more"},
      {"type": "button", "title": "Contact Sales", "value": "contact_sales"}
    ]
  }
}

Create New Conversation

{
  "resource": "conversation",
  "operation": "createConversation",
  "userId": "user-789",
  "additionalFields": {
    "integrationName": "website",
    "tags": "support,priority"
  }
}

Set Conversation Variables

{
  "resource": "state",
  "operation": "setState",
  "conversationId": "conv-123-abc",
  "additionalFields": {
    "stateVariables": {
      "customerType": "premium",
      "lastPurchase": "2024-01-15",
      "supportTier": "priority"
    }
  }
}

Create Custom Event

{
  "resource": "event",
  "operation": "createEvent",
  "conversationId": "conv-123-abc",
  "additionalFields": {
    "eventType": "purchase_completed",
    "eventPayload": {
      "productId": "prod-123",
      "amount": 99.99,
      "currency": "USD"
    }
  }
}

Message Types

Text Messages

• Plain text with optional quick replies
• Markdown formatting support
• Mention capabilities

Card Messages

• Rich cards with images, titles, and action buttons
• Perfect for product showcases and information display

Interactive Elements

• Quick reply buttons for user guidance
• Choice menus for structured interactions
• File uploads and media sharing

Media Messages

• Images with captions and actions
• Video and audio file support
• Document sharing capabilities

Advanced Features

Knowledge Agents

Leverage Botpress's built-in AI to create intelligent responses from custom knowledge bases and documentation.

Sentiment Analysis

Real-time emotion detection helps adapt conversation flow based on user sentiment and engagement levels.

Multi-Channel Deployment

Deploy the same bot across multiple platforms while maintaining conversation context and user profiles.

Enterprise Integration

• Custom webhooks for external system integration
• Advanced analytics and reporting
• Role-based access control
• Audit logs and compliance features

Authentication Types

Personal Access Token (PAT)

• Full account access with user permissions
• Suitable for administrative operations
• Requires careful security handling

Bot Access Key (BAK)

• Limited to bot-specific operations
• Runtime, tables, and files API access
• Recommended for production bot operations

Integration Access Key (IAK)

• Integration-specific access only
• Runtime and files API access
• Perfect for channel-specific integrations

Rate Limiting

Botpress Cloud enforces rate limits per project. Monitor response headers and implement appropriate retry logic for production use.

Support

• Documentation: Botpress Docs
• Issues: GitHub Issues