n8n-nodes-cribops
v0.3.2
Published
n8n community node for reliable webhook processing with Cribops
Maintainers
Keywords
Readme
n8n-nodes-cribops
This is an n8n community node that provides reliable webhook processing capabilities through the Cribops platform.
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
🚀 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
Follow the installation guide in the n8n community nodes documentation.
npm
npm install n8n-nodes-cribopsNodes
This package includes two powerful nodes:
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
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
Credentials
- Create an account at Cribops
- Generate an API token from your dashboard
- In n8n, create new Cribops credentials:
- Base URL: Your Cribops instance URL (e.g.,
https://api.cribops.com) - API Token: Your generated API token
- Base URL: Your Cribops instance URL (e.g.,
Usage Examples
Basic Webhook Reception from Cribops
- Add a Cribops Webhook Trigger node
- Set a webhook path (e.g.,
process-stripe-payments) - Configure options:
- Include Cribops Metadata: Yes (to get tracking info)
- Report Performance: Yes (automatic metrics)
- Report Errors: Yes (automatic error tracking)
- Save and activate your workflow
- The node registers with Cribops and receives webhooks at a controlled rate
Error Reporting
- Add error handling to your workflow
- On error, add a Cribops Webhook node
- Select "Report Error" operation
- Map error details:
- Error message and type
- Stack trace for debugging
- Node that failed
- Whether retry is recommended
Performance Tracking
- At the end of your workflow, add a Cribops Webhook node
- Select "Report Performance" operation
- Track metrics:
- Processing time
- Items processed
- Memory usage
- Success/failure status
Long-Running Process with Progress Updates
- For batch processing, add periodic Cribops Webhook nodes
- Select "Send Progress" operation
- Update progress percentage and message
- 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
- Always Report Errors: Enable error reporting in trigger nodes
- Track Performance: Send performance metrics to identify bottlenecks
- Use Progress Updates: For long-running workflows, send regular progress
- Analyze Workflows: Periodically analyze workflows for optimization opportunities
- Handle Errors Gracefully: Report errors with context to improve retry strategies
Development
Prerequisites
- Node.js >= 20.15
- n8n >= 1.0.0
Setup
# Clone repository
git clone https://github.com/CloudBedrock/n8n-nodes-cribops.git
cd n8n-nodes-cribops
# Install dependencies
npm install
# Start development mode
npm run devBuilding
# Build TypeScript and icons
npm run build
# Lint code
npm run lint
# Format code
npm run formatTesting
# Run tests
npm run test
# Test with local n8n instance
npm link
N8N_CUSTOM_EXTENSIONS=n8n-nodes-cribops n8n startSupport
- Documentation: Cribops Docs
- Issues: GitHub Issues
- Community: n8n Community Forum
License
Important License Clarification:
- The MIT license applies only to this n8n node integration code
- Cribops platform and services are licensed separately by CloudBedrock
- Use of Cribops services requires an active subscription and acceptance of Cribops Terms of Service
- This open-source node is a client interface and does not grant any license to use Cribops services beyond your subscription terms
Changelog
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)
