n8n-nodes-cribops 0.1.20 → 0.2.0

package/README.md

@@ -1,174 +1,160 @@
 # n8n-nodes-cribops
 
-This is an n8n community node. It lets you use Cribops in your n8n workflows.
+This is an n8n community node that provides reliable webhook processing capabilities through the [Cribops](https://cribops.com) platform.
 
-Cribops is the platform where teams build, deploy, and scale AI-powered automation agents for customer service, support, and business operations.
-
-> **Note**: This integration requires an active subscription with [Cribops.com](https://cribops.com). Sign up for an account to obtain your API credentials.
+Cribops is a webhook processing service that ensures reliable delivery, intelligent routing, and comprehensive monitoring of webhooks. This node package allows you to integrate Cribops' powerful webhook infrastructure directly into your n8n workflows.
 
 ## Features
 
-- **Scalable Automation**: Build resilient workflows with AI agents that handle customer interactions at scale
-- **AWS Service Integration**: Leverage AWS SQS queues and SNS topics for enterprise-grade message processing
-- **Real-time Communication**: HTTP webhooks enable instant bidirectional messaging between n8n and Cribops agents
-- **Smart Agent Routing**: Dynamic agent selection ensures messages reach the right automation specialist
-- **Context Preservation**: Maintains full conversation history across complex multi-step workflows
-- **Enterprise Security**: Dual authentication with API tokens and AWS credentials for secure cloud operations
-- **File Processing**: Handle documents, images, and attachments through S3 presigned URLs
-- **Event-Driven Triggers**: Filter and respond to specific event types for targeted automation
-
-## Nodes Included
-
-### 1. Cribops Node
-Execute operations on Cribops automation agents:
-- **Send Messages**: Dispatch requests to AI agents with file attachments and metadata
-- **Manage Conversations**: Reply to ongoing conversations while maintaining full context
-- **Agent Operations**: List available agents, retrieve agent details, and route dynamically
-- **Real-time Status**: Send typing indicators to show processing activity
-- **Custom Properties**: Attach metadata for workflow-specific data handling
-
-### 2. Cribops Trigger Node
-Receive and process events from Cribops automation platform:
-- **Webhook Reception**: Instantly receive messages from users and agents
-- **Smart Filtering**: Process only relevant events (user messages, agent responses, attachments)
-- **Secure Validation**: Verify webhook authenticity with secret tokens
-- **Data Enrichment**: Automatically include routing information for seamless replies
-- **Queue Integration**: Future support for AWS SQS polling for guaranteed message delivery
-- **Topic Subscriptions**: Future support for AWS SNS for event broadcasting
+### 🚀 Webhook Reception & Processing
+- **N8N as Webhook Destination**: Receive webhooks FROM Cribops at a controlled rate
+- **Performance Tracking**: Built-in performance metrics for every webhook processed
+- **Error Reporting**: Automatic error reporting back to Cribops for monitoring
+- **Progress Updates**: Send progress updates for long-running workflows
+
+### 📊 Advanced Monitoring & Reporting
+- **Error Reporting**: Report workflow errors with detailed context and stack traces
+- **Performance Metrics**: Send processing time, memory usage, and success rates
+- **Callbacks**: Send completion callbacks for long-running processes
+- **Progress Tracking**: Update Cribops on workflow progress in real-time
+
+### 🔧 Workflow Optimization
+- **Workflow Analysis**: Send workflow definitions to get optimization recommendations
+- **Scalability Insights**: Get recommendations on when to migrate to Oban Pro or Step Functions
+- **Performance Scoring**: Understand your workflow's scalability potential
+- **Cost Optimization**: Receive cost reduction estimates for optimized workflows
+
+### 🔄 Integration Architecture
+- **Phoenix as Front Door**: Cribops Phoenix receives and stores all webhooks
+- **Controlled Delivery**: N8N receives webhooks at a manageable rate
+- **Hybrid Processing**: Combine N8N's flexibility with Oban Pro's power
+- **Multi-Destination Routing**: Route webhooks to N8N, GHL, custom endpoints, or Oban workers
 
 ## Installation
 
-### Prerequisites
-- Node.js >= 20.15
-- n8n >= 1.0.0
-- Active Cribops subscription (visit [cribops.com](https://cribops.com) to sign up)
-- Cribops API access token (available in your Cribops dashboard)
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+### npm
 
-### Via npm (Recommended)
 ```bash
 npm install n8n-nodes-cribops
 ```
 
-### Via n8n GUI (For verified community nodes)
-1. Go to **Settings** → **Community Nodes**
-2. Click **Install a Community Node**
-3. Enter: `n8n-nodes-cribops`
-4. Click **Install**
-
-### Manual Installation
-```bash
-# Clone the repository
-git clone https://github.com/CloudBedrock/n8n-nodes-cribops.git
-cd n8n-nodes-cribops
+## Nodes
 
-# Install dependencies
-npm install
+This package includes two powerful nodes:
 
-# Build the package
-npm run build
+### 1. Cribops Webhook Trigger
+Receive webhooks FROM Cribops at a controlled rate:
+- Registers your N8N workflow as a webhook destination
+- Receives webhooks with Cribops metadata (queue info, tracking ID, etc.)
+- Automatic performance tracking
+- Built-in error reporting
+- Signature validation for security
 
-# Link globally for testing
-npm link
-```
+### 2. Cribops Webhook
+Report back to Cribops and optimize your workflows:
+- **Report Error**: Send detailed error information back to Cribops
+- **Report Performance**: Track processing time, memory usage, and success rates
+- **Send Callback**: Notify Cribops when long-running workflows complete
+- **Send Progress**: Update progress for workflows processing large batches
+- **Analyze Workflow**: Get optimization recommendations and scalability insights
 
 ## Configuration
 
-### 1. Cribops API Credentials
-Create a new credential in n8n:
-- **Credential Type**: Cribops API
-- **API Token**: Your Cribops API token (Required)
-- **Base URL**: Your Cribops instance URL (e.g., `https://api.cribops.com`)
-- **Account ID**: (Optional) Account ID for AWS service integration
-- **Account Secret**: (Optional) Secret key for AWS service integration
-- **Region**: (Optional) AWS region for cloud services (default: us-east-1)
+### Credentials
 
-### 2. Agent Selection
-The nodes automatically populate available agents from your Cribops instance. Select the appropriate agent from the dropdown when configuring each node.
+1. Create an account at [Cribops](https://cribops.com)
+2. Generate an API token from your dashboard
+3. In n8n, create new Cribops credentials:
+   - **Base URL**: Your Cribops instance URL (e.g., `https://api.cribops.com`)
+   - **API Token**: Your generated API token
 
 ## Usage Examples
 
-### Customer Support Automation
-```
-[Cribops Trigger] → [Sentiment Analysis] → [Route to Agent] → [Cribops Response]
-```
-Automatically analyze customer sentiment and route to specialized AI agents based on urgency and topic.
-
-### Document Processing Pipeline
-```
-[Cribops Trigger] → [Extract Attachment] → [OCR/Parse] → [Database] → [Cribops Response]
-```
-Process incoming documents, extract data, store in database, and respond with confirmation.
-
-### Multi-Channel Integration
-```
-[Slack] → [Format Message] → [Cribops Agent] → [Process] → [Email/SMS/Slack]
-```
-Receive requests from any channel, process with Cribops agents, and respond across multiple platforms.
-
-### Escalation Workflow
-```
-[Cribops Trigger] → [Check Complexity] → [If Complex] → [Human Review] → [Cribops Response]
-```
-Automatically escalate complex requests while handling routine inquiries with AI agents.
-
-## API Integration
-
-### Cribops Platform Endpoints
-- `GET /api/v1/agents` - Agent selection and retrieval
-- `GET /api/v1/agents/{agent_id}` - Get specific agent details
-- `POST /webhooks/agents/{agent_id}/message` - HTTP webhook endpoint
-- `POST /api/v1/agents/{agent_id}/files` - File uploads
-- `POST /api/v1/agents/{agent_id}/typing` - Send typing indicators
-- Response webhook URL provided in incoming messages for replies
-- AWS SQS queue endpoints (when configured with AWS credentials)
-- AWS SNS topic endpoints (when configured with AWS credentials)
-
-### Message Formats
-
-#### Incoming User Message
-```json
-{
-  "conversation_id": "uuid-v4",
-  "content": "Hello, I need help with...",
-  "message_id": "uuid-v4",
-  "user_id": "uuid-v4",
-  "organization_id": "uuid-v4",
-  "timestamp": "2025-01-10T16:00:00Z",
-  "response_webhook": "https://api.cribops.com/webhooks/response/uuid-v4",
-  "type": "user_message",
-  "attachments": [
-    {
-      "type": "image",
-      "url": "https://s3.amazonaws.com/...",
-      "filename": "screenshot.png",
-      "size": 1024000,
-      "mime_type": "image/png"
-    }
-  ]
-}
-```
-
-#### Outgoing Agent Response
-```json
-{
-  "conversation_id": "uuid-v4",
-  "content": "I can help you with that...",
-  "message_id": "external-id-123",
-  "timestamp": "2025-01-10T16:01:00Z",
-  "attachments": [
-    {
-      "type": "file",
-      "url": "https://s3.amazonaws.com/...",
-      "filename": "report.pdf",
-      "size": 2048000,
-      "mime_type": "application/pdf"
-    }
-  ]
-}
-```
+### Basic Webhook Reception from Cribops
+
+1. Add a **Cribops Webhook Trigger** node
+2. Set a webhook path (e.g., `process-stripe-payments`)
+3. Configure options:
+   - Include Cribops Metadata: Yes (to get tracking info)
+   - Report Performance: Yes (automatic metrics)
+   - Report Errors: Yes (automatic error tracking)
+4. Save and activate your workflow
+5. The node registers with Cribops and receives webhooks at a controlled rate
+
+### Error Reporting
+
+1. Add error handling to your workflow
+2. On error, add a **Cribops Webhook** node
+3. Select "Report Error" operation
+4. Map error details:
+   - Error message and type
+   - Stack trace for debugging
+   - Node that failed
+   - Whether retry is recommended
+
+### Performance Tracking
+
+1. At the end of your workflow, add a **Cribops Webhook** node
+2. Select "Report Performance" operation
+3. Track metrics:
+   - Processing time
+   - Items processed
+   - Memory usage
+   - Success/failure status
+
+### Long-Running Process with Progress Updates
+
+1. For batch processing, add periodic **Cribops Webhook** nodes
+2. Select "Send Progress" operation
+3. Update progress percentage and message
+4. At completion, use "Send Callback" operation with results
+
+## Common Use Cases
+
+### 1. Controlled Webhook Processing
+- Cribops Phoenix receives webhooks from Stripe, GitHub, etc.
+- Stores them reliably in Oban Pro
+- Delivers to your N8N workflow at a manageable rate
+- N8N processes and reports back performance/errors
+
+### 2. Long-Running Batch Processing
+- Receive large webhook with 10,000 items
+- Send initial progress update: "Starting processing"
+- Process in batches, sending progress updates
+- On completion, send callback with summary
+- Cribops tracks entire lifecycle
+
+### 3. Intelligent Error Handling
+- When workflow fails, report detailed error to Cribops
+- Cribops analyzes error patterns
+- Suggests retry strategies or routing changes
+- Maintains error dashboard for monitoring
+
+### 4. Workflow Optimization Path
+- Start with N8N for rapid prototyping
+- Use "Analyze Workflow" to get optimization insights
+- When volume increases, get recommendations to:
+  - Migrate to Oban Pro workers
+  - Use AWS Step Functions
+  - Optimize specific bottlenecks
+- Gradual migration with A/B testing
+
+## Best Practices
+
+1. **Always Report Errors**: Enable error reporting in trigger nodes
+2. **Track Performance**: Send performance metrics to identify bottlenecks
+3. **Use Progress Updates**: For long-running workflows, send regular progress
+4. **Analyze Workflows**: Periodically analyze workflows for optimization opportunities
+5. **Handle Errors Gracefully**: Report errors with context to improve retry strategies
 
 ## Development
 
+### Prerequisites
+- Node.js >= 20.15
+- n8n >= 1.0.0
+
 ### Setup
 ```bash
 # Clone repository
@@ -201,119 +187,37 @@ npm run test
 
 # Test with local n8n instance
 npm link
-npm link n8n-nodes-cribops
 N8N_CUSTOM_EXTENSIONS=n8n-nodes-cribops n8n start
 ```
 
-## Configuration Examples
-
-### Environment Variables
-```bash
-# For local development
-export CRIBOPS_API_URL=http://localhost:4000
-
-# AWS configuration (optional)
-export AWS_REGION=us-east-1
-export AWS_ACCESS_KEY_ID=your_access_key
-export AWS_SECRET_ACCESS_KEY=your_secret_key
-
-# For n8n configuration
-export N8N_CUSTOM_EXTENSIONS=n8n-nodes-cribops
-export N8N_NODES_INCLUDE=n8n-nodes-cribops
-```
-
-### Docker Configuration
-```dockerfile
-FROM n8nio/n8n:latest
-
-# Install the community node
-RUN npm install -g n8n-nodes-cribops
-
-# Set environment variables
-ENV N8N_CUSTOM_EXTENSIONS=n8n-nodes-cribops
-```
-
-## Troubleshooting
-
-### Common Issues
-
-#### Node Not Appearing in n8n
-1. Ensure the package is properly installed
-2. Check that `N8N_CUSTOM_EXTENSIONS` is set correctly
-3. Restart n8n after installation
-
-#### Webhook Connection Issues
-1. Verify webhook URL is correctly configured
-2. Check bearer token authentication
-3. Ensure Cribops platform can reach your n8n instance
-
-#### File Upload Problems
-1. Verify S3 configuration in Cribops platform
-2. Check file size limits
-3. Ensure proper MIME type handling
-
-### Debug Mode
-Enable debug logging in n8n:
-```bash
-export N8N_LOG_LEVEL=debug
-n8n start
-```
-
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
+## Support
 
-### Development Guidelines
-- Follow TypeScript best practices
-- Add tests for new functionality
-- Update documentation as needed
-- Follow n8n community node guidelines
+- **Documentation**: [Cribops Docs](https://docs.cribops.com)
+- **Issues**: [GitHub Issues](https://github.com/CloudBedrock/n8n-nodes-cribops/issues)
+- **Community**: [n8n Community Forum](https://community.n8n.io)
 
 ## License
 
-This n8n community node is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+[MIT](https://github.com/CloudBedrock/n8n-nodes-cribops/blob/master/LICENSE)
 
 **Important License Clarification:**
 - The MIT license applies **only** to this n8n node integration code
-- Cribops platform, services, and AI agents are licensed separately by CloudBedrock
+- Cribops platform and services are licensed separately by CloudBedrock
 - Use of Cribops services requires an active subscription and acceptance of Cribops Terms of Service
-- CloudBedrock proprietary components and APIs remain under CloudBedrock's commercial license
 - This open-source node is a client interface and does not grant any license to use Cribops services beyond your subscription terms
 
-## Support
-
-- **Documentation**: [GitHub Wiki](https://github.com/CloudBedrock/n8n-nodes-cribops/wiki)
-- **Issues**: [GitHub Issues](https://github.com/CloudBedrock/n8n-nodes-cribops/issues)
-- **Community**: [n8n Community](https://community.n8n.io)
-- **Cribops Platform**: [cribops.com](https://cribops.com)
-
 ## Changelog
 
-### Version 0.1.5
-- Initial release
-- HTTP webhook support for sending and receiving messages
-- File attachment handling with S3 presigned URLs
-- Dynamic agent selection with search functionality
-- Reply to conversation functionality with webhook context
-- Typing indicator support
-- Event type filtering for trigger node
-- AWS credentials support for future SQS/SNS integration
-- Secret token validation for webhooks
-- Message metadata support
-
-## Related Projects
-
-- [n8n](https://github.com/n8n-io/n8n) - Workflow automation platform
-- [Cribops AI](https://cribops.com) - AI agent platform
-
----
-
-**Note**: This is a community-maintained package that requires an active Cribops subscription. For official support, please contact the Cribops AI team at [cribops.com](https://cribops.com).
-
-## Disclaimer
-
-This n8n node is provided as an open-source integration tool. CloudBedrock and Cribops are registered trademarks of CloudBedrock, Inc. The use of these trademarks in this project is for identification purposes only and does not imply endorsement.
+### Version 0.2.0
+- Complete architectural shift: N8N as webhook destination, not source
+- Removed chat/conversation features (moved to separate package)
+- Added error reporting operation for workflow monitoring
+- Added performance metrics reporting
+- Added callback operation for long-running workflows
+- Added progress tracking for batch processing
+- Added workflow analysis for optimization recommendations
+- Updated trigger to receive webhooks FROM Cribops
+- Integration with Cribops' intelligent routing system
+
+### Version 0.1.x
+- Initial releases with chat functionality (deprecated)

package/dist/credentials/CribopsApi.credentials.js

@@ -15,23 +15,16 @@ class CribopsApi {
             },
             default: '',
             required: true,
-            description: 'The API token for authenticating with Cribops platform',
+            description: 'The API token for authenticating with Cribops webhook service',
         },
         {
             displayName: 'Base URL',
             name: 'baseUrl',
             type: 'string',
-            default: 'https://cribops.com',
+            default: 'https://api.cribops.com',
             required: true,
             description: 'Base URL of the Cribops API',
         },
-        {
-            displayName: 'Organization ID',
-            name: 'organizationId',
-            type: 'string',
-            default: '',
-            description: 'Organization ID (optional - if not provided, will use the default organization for the API token)',
-        },
     ];
     authenticate = {
         type: 'generic',
@@ -44,7 +37,7 @@ class CribopsApi {
     test = {
         request: {
             baseURL: '={{$credentials.baseUrl}}',
-            url: '/api/v1/agents',
+            url: '/api/v1/health',
             method: 'GET',
         },
     };

package/dist/credentials/HiveApi.credentials.d.ts

@@ -0,0 +1,7 @@
+import { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class HiveApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/HiveApi.credentials.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HiveApi = void 0;
+class HiveApi {
+    name = 'hiveApi';
+    displayName = 'Hive Accelerator';
+    documentationUrl = 'https://docs.cribops.com/hive';
+    properties = [
+        {
+            displayName: 'Host',
+            name: 'host',
+            type: 'string',
+            default: 'localhost',
+            required: true,
+            description: 'Hive server hostname or IP address',
+        },
+        {
+            displayName: 'Port',
+            name: 'port',
+            type: 'number',
+            default: 6379,
+            required: true,
+            description: 'Hive server port (Redis protocol)',
+        },
+        {
+            displayName: 'Password',
+            name: 'password',
+            type: 'string',
+            typeOptions: {
+                password: true,
+            },
+            default: '',
+            description: 'Optional password for Hive authentication',
+        },
+        {
+            displayName: 'Use TLS',
+            name: 'tls',
+            type: 'boolean',
+            default: false,
+            description: 'Whether to use TLS encryption for the connection',
+        },
+    ];
+}
+exports.HiveApi = HiveApi;

package/dist/nodes/Cribops/Cribops.node.d.ts

@@ -1,10 +1,5 @@
-import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription, ILoadOptionsFunctions, INodeListSearchResult } from 'n8n-workflow';
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
 export declare class Cribops implements INodeType {
     description: INodeTypeDescription;
-    methods: {
-        listSearch: {
-            searchAgents: (this: ILoadOptionsFunctions, filter?: string) => Promise<INodeListSearchResult>;
-        };
-    };
     execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
 }