| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Community Apps Dependencies | Show |
| Lines of code | 2907 |
| Technical Name |
webhooks |
| License | OPL-1 |
| Website | http://www.synconics.com |
| Versions | 9.0 10.0 11.0 12.0 13.0 14.0 15.0 16.0 17.0 18.0 |
Webhooks (A user-defined HTTP callbacks) allows you to subscribe certain events that happens in Odoo. When one of these events are triggered, Odoo will send a HTTP POST payload to the webhook's configured URL. The RESTful API accesses Odoo using standard HTTP GET, PUT, POST, and DELETE methods and a simple JSON input and output format.
Webhooks is a useful tool for apps that want to execute operation after specific event happens in Odoo, simultaneously the data will be sent to the other system.
For example after a warehouse manager creates a new product, updates a stock quantity for existing products or sales manager confirm the quotation.
By using our Odoo Webhook app, your application gains a more responsive, resource-efficient and scalable solution. Say goodbye to unnecessary API polling and welcome real-time event notifications, enhancing the overall performance and user experience of your integrated application.
Community-
Enterprise
(On-premises) - Odoo.sh
Online
Community
Online
Create Record
Update Record
Delete Record
Filtering Fields
Filtering Records
Format Support
| Send New (created) Record | Immediately sends new (created) record |
|---|---|
| Send updated Record | Immediately sends updated record |
| Send Deleted Record | Immediately sends deleted record |
| Filtering Fields | Trigger only certain fields when record is updated |
| Filtering Records | Trigger only if operations are performed on certain record |
| Format Supported | Supports JSON and XML format to send the record |
Using the following request, user can get the existing webhooks.
GET /restapi/1.0/webhooks
Get a list of webhooks of particular ids.
GET /restapi/1.0/webhooks?ids={comma_separated_ids}
Get a list of specific webhooks using domain filter
GET /restapi/1.0/webhooks/?domain={comma_separated_list_of_args}
Get a total count of webhooks
GET /restapi/1.0/webhooks/count
Create a new webhook
POST /restapi/1.0/webhooks?vals={values_for_the_object's_fields}
Delete a single Webhook from the database
DELETE /restapi/1.0/webhooks/{id}
Delete multiple Webhooks from the database
DELETE /restapi/1.0/webhooks?ids={comma_separated_ids}
Once you register a webhook URL with Odoo, it will issue a HTTP POST request to specified URL, every time when the event occurs. The request's POST parameters will contain XML/JSON data relevant to the event that triggered the request.
For testing and implementation of Webhook you need a publicly visible URL
During development, there are a couple of tools that make working with webhooks much easier such as RequestBin, Pagekite and ngrok.
Webhook acknowledges receiving data by sending 200 OK response. Any response outside 200 range will inform Odoo that the Webhook is not received. Odoo has implemented a configurable timeout period and a retry period for subscriptions under Settings > General Settings > Webhook Configuration.
The system waits for configured response timeout period (default is 5 seconds), if the response is not received or an error is received, then the system re-tries for configured retry period (default retry - 5 times). A webhook request job will be deleted if there are N number of consecutive failures for the same webhook (N being a configured retry period, default is 5 times). Monitor the admin of your webhook tool for failing webhooks.
It is recommended to have a fast server to respond back to Odoo Webhook, a late response will might triger to timeout. Or if the servers are slow, the timeout can be configured to more seconds.
- Odoo REST API (Version 9.0 Community & Enterprise)
- Odoo REST API (Version 10.0 Community & Enterprise)
- Odoo REST API (Version 11.0 Community & Enterprise)
- Odoo REST API (Version 12.0 Community & Enterprise)
- Odoo REST API (Version 13.0 Community & Enterprise)
- Odoo REST API (Version 14.0 Community & Enterprise)
- Odoo REST API (Version 15.0 Community & Enterprise)
- Odoo REST API (Version 16.0 Community & Enterprise)
- Odoo REST API (Version 17.0 Community & Enterprise)
Follow the quick reference guide link below for using Odoo Webhooks:
https://synconics.gitbook.io/webhook/
Can we send payment via authorize.net using this module?
No, You can only accept payment through this module. Authorize.net only supports accepting payment.
Does this module save customer's full payment details?
No, As per PCI compliance the module stores payment details in secure token form.
Does this module support partial payment with the same order?
Yes, You can pay partial or full payment with this module from the backend.
Does this module support notification functionality on payment settlement?
No, this module does not support this functionality. You need to customize it.
Will it be possible for you to reduce a few functionality of this module as per my business flow?
Sure , kindly drop an email contact@synconics.com or ping us on our Skype ID: synconics.technologies.
All the apps are to be purchased separately, for individual versions and
individual edition.
-
One month free bug support period will be offered pertaining to any one
server used, testing or live.
-
Synconics is not responsible for installation or updating of the module on
any of your server.
-
If an error appears in our app due to other custom modules installed in your
system or if Odoo base source code is not updated on your system, to make it
compatible with your source code, we'll charge you for our efforts to
resolve those errors and make the module compatible with your source code.
-
Please refer the document for configuration. If any support is needed for
module configuration, installation, updating or any help is needed, it will
be considered in paid support.
-
Please note that you are not allowed to distribute or resell this module
after purchase.
-
This module is tested and working on Odoo vanilla with Ubuntu OS.
-
Support services will be provided from Monday to Friday, 10:30 AM to 7 PM
IST (Indian Standard Time).
-
Support will not be provided during Indian public holidays or company
holidays.
All the apps are to be purchased separately, for individual versions and
individual edition.
Our Apps
Our Themes- Configuration
- Odoo Hosting
- Customisation
- Functional
Training
- Technical
Training
- Support &
Maintenance
- Dedicated
Developer
- Implementation
- Odoo Migration
- API Integration
connect on whatsapp.
Odoo Webhooks: Version 1.0 documentation
Webhooks(A user-defined HTTP callbacks) are a useful tool for apps that want to execute code after a specific event happens on an Odoo, for example, after a warehouse manager creates a new product, updates a stock quantity for existing products or sales manager confirm the quotation.
Instead of telling your app to make an API call every X number of minutes to check if a specific event has occured on an Odoo, you can register webhooks, which send an HTTP request from the Odoo telling your app that the event has occurred. This uses many less API requests overall, allowing you to build more robust apps, and update your app instantly after a webhook is received.
Webhook event data can be stored as JSON or XML, and is commonly used when:
- Placing an order
- Changing a product's price
- Collecting data for data-warehousing
- Integrating your accounting software
- Filtering the order items and informing various shippers about the order
Another, less-obvious, case for using webhooks is when you're dealing with data that isn't easily searchable through the Odoo API. For example, re-requesting an entire product catalog or order history would benefit from using webhooks since it requires a lot of API requests and takes a lot of time.
Think of it this way, if you would otherwise have to poll for a substantial amount of data, you should be using webhooks.
Get the module
The module webhook is available on Odoo App Store, Here are links for:
Dependencies
The module webhook is depend on restapi module, which is also available on Odoo App Store, Here are links for:
Note
Odoo REST API documentation is available here, which will give you complete guide for how to install and work with restapi module.
Installation
There are two ways to install module:
Directly from App store
- Activate Developer Mode
- Navigate to the Apps menu
- Click on second Apps menu if you are using version 9.0 otherwise App Store menu in left side bar
- Remove Featured [x] filter from search bar
- search module webhook
- Click on Install button.
By puting module in addons
- Unzip webhook module to custom addons directory
- Restart odoo server
- Activate Developer Mode
- Navigate to the Apps menu
- Click on Update Apps List menu in left side bar
- Once apps list is updated, click on Apps menu in left side bar
- Search module webhook
- Click on Install button.
Getting Started
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module