Odoo Webhook

by
Odoo

$ 215.88

v 15.0 Third Party 44
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Community Apps Dependencies
Lines of code 2439
Technical Name webhooks
LicenseOPL-1
Websitehttp://www.synconics.com
Versions 14.0 17.0 13.0 11.0 9.0 15.0 12.0 16.0 10.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Community Apps Dependencies
Lines of code 2439
Technical Name webhooks
LicenseOPL-1
Websitehttp://www.synconics.com
Versions 14.0 17.0 13.0 11.0 9.0 15.0 12.0 16.0 10.0

Odoo Webhook

Webhooks(A user-defined HTTP callbacks) allow you to subscribe to certain events that happen 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.
It uses both the OAuth1 and OAuth2 protocols to authenticate 3rd party applications.
Webhooks 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.
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.

This module is compatible with

Authentication

Provides Authentication with both Oauth1 And Oauth2 protocols.

Send Created Record

Send the record immediately when record is created.

Send Updated record

Send the record immediately when record is created.

Send Deleted record

Send the record immediately when record is deleted.

Support Formats

Supports JSON and XML format to send the record.

Filtering Records

Trigger only if operations are performed on certain record.

Filtering Fields

Trigger only certain fields when record is updated.

Get a Webhooks

Using the following request, user can get the existing webhooks.

GET
/restapi/1.0/webhooks

Get Particular Webhooks

Get a list of webhooks of particular ids.

GET
/restapi/1.0/webhooks?ids={comma_separated_ids}

Get filtered webhooks

Get a list of specific webhooks using domain filter

GET
/restapi/1.0/webhooks/?domain={comma_separated_list_of_args}

Get Count of Webhook

Get a total count of webhooks

GET
/restapi/1.0/webhooks/count

Create Webhook using RestApi

Create a new webhook

POST
/restapi/1.0/webhooks?vals={values_for_the_object's_fields}

Update a single webhook using RestApi

Update a single record using RestApi

PUT
/restapi/1.0/webhooks/{id}?vals={fields_and_values_to_update}

Update multiple records using RestApi

PUT
/restapi/1.0/webhooks?ids={comma_separated_ids}&vals={fields_and_values_to_update}

Delete Webhook using RestApi

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}

Receive a webhook

Once you register a webhook URL with Odoo, it will issue a HTTP POST request to the URL specified every time that event occurs. The request's POST parameters will contain XML/JSON data relevant to the event that triggered the request.

The trouble with testing your webhooks is that you need a publicly visible URL to handle them.

There are a couple of tools that make working with webhooks during development much easier such as RequestBin, Pagekite and ngrok.

Respond to a webhook

Your webhook acknowledges that it received data by sending a 200 OK response. Any response outside of the 200 range will let Odoo know that you did not receive your webhook. Odoo has implemented a configurable timeout period and a retry period for subscriptions under Settings > General Settings > Webhook Configuration.
We wait for a response to each request till configured timeout period (default is 5 seconds), and if there isn't one or we get an error, we retry the connection for configured retry periods (default is 5 times). A webhook request job will be deleted if there are N number of consecutive failures for the exact same webhook (N being a configured retry period, default is 5 times). You should monitor the admin of your webhook tool for failing webhooks.
If you're receiving an Odoo webhook, the most important thing to do is respond quickly. There have been several historical occurrences of apps that do some lengthy processing when they receive a webhook that triggers the timeout. This has led to situations where webhooks were removed from functioning apps.
To make sure that apps don't accidentally run over the timeout limit, we now recommend that apps defer processing until after the response has been sent.

Webhook Quick Reference Guide

Consider following link for a quick reference guide to use the odoo webhooks:
https://synconics.gitbook.io/webhook/

Suggested Products
Our Apps

Terms & Conditions

  • 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.
Questions? Get in touch!

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

  1. Activate Developer Mode
  2. Navigate to the Apps menu
  3. Click on second Apps menu if you are using version 9.0 otherwise App Store menu in left side bar
  4. Remove Featured [x] filter from search bar
  5. search module webhook
  6. Click on Install button.

By puting module in addons

  1. Unzip webhook module to custom addons directory
  2. Restart odoo server
  3. Activate Developer Mode
  4. Navigate to the Apps menu
  5. Click on Update Apps List menu in left side bar
  6. Once apps list is updated, click on Apps menu in left side bar
  7. Search module webhook
  8. 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

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.
There are no ratings yet!
How can I know how to implement it, and use features
by
Optimus
on 1/24/24, 4:15 AM

How can I know how to implement it, and use features 

Re: How can I know how to implement it, and use features
by
Synconics Technologies Pvt. Ltd.
on 1/24/24, 4:48 AM Author

Hello Optimus,

Thanks for message and showing interest in our app.

Please send us mail on : contact@synconics.com or

Add us on Skype : synconics.technologies 

we will explain you the module functionality.

Regards,

Synconics