MuK Webhooks for Odoo

by
Odoo

132.90

v 16.0 Third Party 76
Live Preview
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Lines of code 1780
Technical Name muk_webhooks
LicenseSee License tab
Websitehttp://www.mukit.at
Versions 13.0 12.0 14.0 16.0 15.0 11.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Lines of code 1780
Technical Name muk_webhooks
LicenseSee License tab
Websitehttp://www.mukit.at
Versions 13.0 12.0 14.0 16.0 15.0 11.0

MuK Webhooks for Odoo

Customizable Webhooks for Odoo

MuK IT GmbH - www.mukit.at

Community Enterprise onPremise Odoo.sh Odoo Online

Overview

Webhooks are user-defined HTTP callbacks that can be used to perform push notifications. They are usually triggered by some event, such as creating a new partner or a comment being posted to a blog. When that event occurs, Odoo makes an HTTP request to the URL configured for the webhook. Webhooks can easily configured and customized in the backend.

Customize Process

It is possible to customize the process at two points. Once before the request is sent. In the tab "Adaot Payload" Python code can be written and in addition, fields can be defined, which are then automatically appended to the request. In a second step the received response can be processed by writing code in the "Process Response" tab. This receives the response as context.

Authentication

Furthermore there is the possibility to set an automatic authentication on the hook. There are a number of variants for this, such as Access Token or OAuth. The corresponding values for authentication are then automatically appended to the webhook.

Preview Requests

In order to test the webhook you can click on the "Preview Action" button at any time. This opens a dialog which allows to test different scenarios. This way a complete process can be tested, which actually sends a request and if necessary makes changes in the database. Or only the payload can be built without sending a request.

Logging and Analytics

If set, every request of a webhook is logged. Both the request itself and the response. This data can also be analyzed as a graph to get an overview of the generated traffic. If a request fails, it can be resent manually via the log entry if necessary.

Help and Support

Feel free to contact us, if you need any help with your Odoo integration or additional features.
You will get 30 days of support in case of any issues (except data recovery, migration or training).

Our Services

Odoo
Development

Odoo
Integration

Odoo
Infrastructure

Odoo
Training

Odoo
Support

MuK Webhooks for Odoo

Webhooks are user-defined HTTP callbacks that can be used to perform push notifications. They are usually triggered by some event, such as creating a new partner or a comment being posted to a blog. When that event occurs, Odoo makes an HTTP request to the URL configured for the webhook. Webhooks can easily configured and customized in the backend.

Requirements

Following you will find a list of requirements. These are not always mandatory to install the module, but without them the functionality will be limited.

OAuthLib

A generic, spec-compliant, thorough implementation of the OAuth request-signinglogic for Python. To install OAuthLib please follow the instructions or install the library via pip.

pip install oauthlib

Requests-OAuthlib

Requests-OAuthlib uses the Python Requests and OAuthlib libraries to provide an easy-to-use Python interface for building OAuth1 and OAuth2 clients. To install Requests-OAuthlib please follow the instructions or install the library via pip.

pip install requests requests_oauthlib

Installation

To install this module, you need to:

Download the module and add it to your Odoo addons folder. Afterward, log on to your Odoo server and go to the Apps menu. Trigger the debug mode and update the list by clicking on the "Update Apps List" link. Now install the module by clicking on the install button.

Upgrade

To upgrade this module, you need to:

Download the module and add it to your Odoo addons folder. Restart the server and log on to your Odoo server. Select the Apps menu and upgrade the module by clicking on the upgrade button.

Configuration

To configure this module, you need to:

  1. Go to Settings -> Webhooks -> Automation.
  2. Click on Create to create a new webhook and customize it to your needs.
  3. Start by selection a model and a trigger. The trigger defines when the webhook should be executed.
  4. Enter the URL and the header values as well as the payload fields. The selected fields are automatically read from the record(s) for which the webhook is triggered.

To test the webhook you can click on the Preview Action button at any time. This opens a dialog which allows to test different scenarios. This way a complete process can be tested, which actually sends a request and if necessary makes changes in the database. Or only the payload can be built without sending a request.

The webhooks also have the possibility to set different authentication methods. For this purpose, a new authentication object can be created, which can then be used for multiple hooks.

The following options are possible:

  • Basic
  • Digest
  • Token
  • OAuth2 (Password Credentials, Client Credentials)

In case a CSRF token is needed for the request there is also a setting object for it.

To further customize the hook there is the possibility to write phyton code to extend both the header and the payload. Within the python code there is access to the same variables as with regular Odoo automations or actions. The same applies to the python code block which can be used to interpret the response from the hook.

Usage

After creating a webhook (automation) it is automatically triggered by the system. If the webhook is created as an action, it is available as a server action in the action dropdown menu. In case of a scheduele the hook will be executed according to the settings.

Credit

In this section you will find information about the contributors and the maintainers of the app.

Contributors

Images

Some pictures are based on or inspired by:

  • Prosymbols
  • Smashicons

Author & Maintainer

This module is maintained by the MuK IT GmbH.

MuK IT is an Austrian company specialized in customizing and extending Odoo. We develop custom solutions for your individual needs to help you focus on your strength and expertise to grow your business.

If you want to get in touch please contact us via mail or visit our website.

MuK 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 MuK IT GmbH.

The above permissions are granted for a single database per purchased
license. Furthermore, with a valid license it is permitted to use the
software on other databases as long as the usage is limited to a testing
or development environment.

You may develop modules based on the Software or 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
MuK 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!
by
Jean-Jacques COTEL
on 12/21/23, 3:35 AM

Hello,

Can you tell me if your module will be disponible for V17 asap ? Have you plan a date ? We need to start our developpments at the beginning of january 2024.
We need a solution for our project.

Thanks for you answer.

Jean-Jacques COTEL