| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 1700 |
| Technical Name |
ksro_rest_api |
| License | LGPL-3 |
| Website | https://ksrolabs.com |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 1700 |
| Technical Name |
ksro_rest_api |
| License | LGPL-3 |
| Website | https://ksrolabs.com |
Real-Time Integrations for Odoo 18 Real-Time Integrations
Push live Odoo data to any system instantly. No polling. No delays. When something changes, your integrations know immediately.
Event-driven webhooks deliver data in real-time. Sync sales orders to warehouses, invoices to accounting, inventory to e-commerce — instantly. Includes REST API for on-demand access. $149 — One license for unlimited databases and unlimited webhooks.
Webhooks vs REST API Polling
Why webhooks are the modern standard for real-time integrations. Push beats pull. Always.
✓ KSRO Webhooks (Real-Time Push)
- Instant Delivery (< 1 second)
- Zero Latency — data arrives immediately
- Event-Driven — only notify on changes
- Automatic Retry — exponential backoff
- HMAC-SHA256 Signed — secure payloads
- Per-Event Configuration — create, write, delete, all
- Wildcard Support — watch any model
- 90-Day Audit Log — every webhook tracked
- No API Quota Wasted — no polling overhead
- REST API Included — for on-demand access
- Bulk Operations — up to 200 at once
- $149 — unlimited webhooks, unlimited databases
○ Traditional REST API Polling
- Delayed data (5-60 minute intervals)
- High latency — data outdated
- Poll-based — constant checks
- Manual retry logic
- Minimal security verification
- Fixed polling intervals
- Limited scope — specific records only
- Basic or no logging
- Wastes 99% of API calls on polling
- REST API only
- Bulk operations (limited)
- Higher total cost
Webhooks Management Made Simple
Set up webhooks in the Odoo UI in 2 minutes. No coding required. Select model, event type, target URL. That's it.
Setup in 2 minutes: Select model to watch (sale.order, res.partner, etc.) → Choose event type (create, write, delete, all) → Enter target URL (webhook endpoint) → Add signing secret (optional, recommended) → Configure retry count (default: 3) → Set timeout (default: 10 seconds) → Activate and done!
Location: Settings → API → Logs — See all webhook activity: Every webhook sent (request & response) • Status codes (200, 400, 500, etc.) • Timestamp when webhook was triggered • Response time (latency) • Number of retry attempts • Full request/response payload • IP address that received it • 90-day retention by default • Search and filter logs
Built For Real-Time Integration Teams
Whether you're syncing to external systems, automating workflows, or building real-time applications — webhooks eliminate delays and manual syncing.
Send new sales orders to warehouse systems instantly. No more manual data entry. Inventory updates flow back to Odoo in real-time.
Real-time invoice and payment notifications to accounting software. Automate reconciliation. No more waiting for batch imports.
Push product updates, orders, and inventory to Shopify, WooCommerce instantly. Keep everything in sync without manual exports.
Trigger n8n workflows, Zapier automations instantly on Odoo events. Build low-code integrations with real-time triggers.
Build event-driven applications. Webhooks are the standard for modern APIs. React to Odoo changes in your app instantly.
Webhooks with HMAC signatures, IP restrictions, audit logs, and rate limiting. Everything needed for compliance and governance.
Complete Feature Set
Everything you need: Real-time webhooks + REST API for on-demand access. Production-ready with no external dependencies.
🔗 Real-Time Webhooks
Event Types: Monitor create, write, delete, or all events on any model.
Instant Delivery: Sub-second latency. Push data the moment it changes in Odoo.
Automatic Retry: Exponential backoff retry logic. Configurable retry count (0-10). Built-in timeout handling.
HMAC-SHA256 Signing: Each webhook payload signed. Verify authenticity with X-KSRO-Signature header.
Per-Webhook Configuration: Target URL, secret, timeout, retry count. Tailor each webhook to your needs.
Audit Logging: Every webhook tracked with timestamp, status code, response time, full payload.
Works with Anything: Zapier, n8n, custom backends, webhooks.site, RequestBin — any HTTP endpoint.
🔑 REST API (On-Demand Data Access)
Full CRUD: Search, create, read, write, delete with flexible domain filters and field selection.
Authentication: JWT tokens or API keys. Stateless, no session required. HS256 signatures.
Rate Limiting: Per-minute sliding window. Atomic Postgres-backed. No Redis dependency. Configurable per key.
Bulk Operations: Create, update, or delete up to 200 records in one atomic request. All-or-nothing or best-effort modes.
File Handling: Upload attachments, download binary fields, manage files directly via API.
Report Generation: Download PDF and XLSX reports directly. Auto-renders and streams binary.
OpenAPI + Swagger UI: Full API documentation at /api/docs. Test endpoints in browser. Swagger UI included.
Postman Collection: Auto-generated. Import into Postman. Pre-configured requests. Ready to test.
🔐 Enterprise Security & Governance
API Key Security: SHA-256 hashing. Raw key shown once. Never stored in plaintext. Rotate or revoke instantly.
IP Allowlist: CIDR-based restrictions per key. Only trusted sources can make API calls.
Per-Key Model ACL: Each key restricted to specific models. Sales team gets sales.order. Accounting gets account.move.
Audit Trail: Every API call logged (method, endpoint, model, status, IP, duration). 90-day retention. Searchable.
Webhook Verification: HMAC-SHA256 signatures. Verify payload authenticity before processing.
Rate Limiting: Prevent abuse. Per-key configurable limits. No denial of service.
LGPL-3 License: Open source. No proprietary lock-in. Full source code included. Fork and customize.
📚 Documentation & Developer Experience
OpenAPI 3.0 Spec: GET /api/docs/openapi.json serves complete specification.
Swagger UI: Interactive explorer at /api/docs. Test endpoints directly in browser.
Postman Collection: GET /api/docs/postman.json for instant import. Pre-configured requests ready to use.
Comprehensive Docs: Full specification with examples. Every endpoint documented. Request/response samples included.
Consistent Errors: Structured JSON error responses. Meaningful error codes. Clear messages for debugging.
Enterprise Security Built In
For teams that need compliance, audit trails, and governance without the enterprise price tag.
Keys stay secure. Shown once, never stored in plaintext. Rotate or revoke instantly.
Every API call and webhook logged and searchable. Know exactly who accessed what, when, and from where.
Restrict access by IP address. Only allow integrations from trusted sources.
Give each integration only the data it needs. Restrict keys to specific models.
Prevent abuse and traffic spikes. Configurable limits per API key.
Modern token-based auth. Revoke access instantly without database changes.
Cryptographically signed payloads. Know your webhooks are really from Odoo.
LGPL-3 licensed. No vendor lock-in. Modify, extend, and customize freely.
Up and Running in Minutes
📸 NOTE: This screenshot shows Settings → API menu with all submenus: Dashboard, Webhooks, API Keys, Logs, Allowed Methods, Documentation. Replace with your actual menu navigation showing the complete menu structure.
Step 1: Install the module
Step 2: Create your first webhook
Navigate to Settings → API → Webhooks → Click New
• Watch Model: Sales Order
• Event Type: All Events
• Target URL: https://your-warehouse.com/webhook
• Signing Secret: your_secret_key (optional)
• Retry Count: 3
• Click Save
Step 3: Test the webhook
Go to Sales → Orders → Create a new order → Save
Within 1 second, your webhook endpoint receives a POST with order data. That's it!
Step 4: Use REST API for on-demand access
Step 5: View API documentation
Visit https://your-odoo.com/api/docs to see interactive API documentation with Swagger UI. Test endpoints directly in the browser. Download Postman collection.
Everything Included. Nothing Extra.
- Instant event notifications
- HMAC-SHA256 signed payloads
- Automatic retry logic
- Audit logging included
- Unlimited webhooks
- Full CRUD operations
- JWT & API Key auth
- Bulk operations (up to 200)
- File upload/download
- Report generation
- OpenAPI 3.0 spec
- Swagger UI at /api/docs
- Postman collection export
- Full code examples
- Comprehensive guides
- Rate limiting
- IP allowlists
- Per-key ACL
- Audit logging (90 days)
- LGPL-3 open source
Frequently Asked Questions
Why webhooks instead of REST API polling?
Webhooks push data instantly when events happen. Polling is slow, inefficient, and wasteful. Webhooks eliminate 99% of API calls, reduce latency from minutes to seconds, and enable real-time integrations. This is the modern standard.
Can I use webhooks with n8n, Zapier, and custom systems?
Yes! Webhooks work with any platform. n8n, Zapier, Make.com, custom backends, and any HTTP endpoint can receive Odoo webhooks. This is the beauty of webhooks—they're universally supported.
What if my webhook endpoint is temporarily down?
Webhooks automatically retry up to 3 times (configurable) with exponential backoff. If it fails, it's logged for debugging. You can view all webhook attempts in Settings → API → Logs. You won't miss events.
Can I use this in production?
Yes! All code is production-ready. It includes HMAC-signed webhooks, automatic retry logic, IP allowlists, atomic rate limiting, audit logging, comprehensive error handling, and security features. Used by integration teams and enterprises.
How many databases can I install this on?
Unlimited databases with a single $149 purchase. One license covers all your instances, development, staging, and production environments.
Do I need Redis for rate limiting?
No. Rate limiting uses atomic Postgres INSERT...ON CONFLICT, which is faster and more reliable than Redis for this use case. Zero external dependencies.
Can I modify the code?
Yes! It's LGPL-3 licensed, so you can fork, modify, and redistribute. Full source code is included.
Ready to Stop Polling and Start Real-Time?
Get real-time webhooks + REST API with HMAC signing, automatic retries, audit logging, and enterprise security. Production-ready out of the box.
LGPL-3 License • Unlimited Databases • Unlimited Webhooks • 30-Day Money-Back Guarantee
KSRO Webhooks Pro — Real-Time Integrations for Odoo 18
Version 18.0.1.0.0 • LGPL-3 Licensed
© 2024 KSRO Labs. All rights reserved.
Documentation •
GitHub •
Support
Please log in to comment on this module