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:

• Version 16.0 (Community & Enterprise)

• Version 15.0 (Community & Enterprise)

• Version 14.0 (Community & Enterprise)

• Version 13.0 (Community & Enterprise)

• Version 12.0 (Community & Enterprise)

• Version 11.0 (Community & Enterprise)

• Version 10.0 (Community & Enterprise)

• Version 9.0 (Community & Enterprise)

Dependencies

The module webhook is depend on restapi module, which is also available on Odoo App Store, Here are links for:

• Version 16.0 (Community & Enterprise)

• Version 15.0 (Community & Enterprise)

• Version 14.0 (Community & Enterprise)

• Version 13.0 (Community & Enterprise)

• Version 12.0 (Community & Enterprise)

• Version 11.0 (Community & Enterprise)

• Version 10.0 (Community & Enterprise)

• Version 9.0 (Community & Enterprise)

• Version 8.0 (Community & Enterprise)

Note

Odoo REST API documentation is available here, which will give you complete guide for how to install and work with restapi module.

Installation

1. Unzip webhook module to custom addons directory

2. Restart odoo server

3. Activate Developer Mode from the Settings menu

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 / top side bar

7. Search module webhook

8. Click on Install button.

Getting Started

• Configuration

  • Through the API

  • Through your user panel

• Properties

• Endpoints

  • Get a Webhooks

    • Get a list of all Webhooks

    • Get a single Webhook by it's ID

    • Get a list of Webhooks of particular ids

    • Get a list of specific Webhooks using domain filter

  • Get a count of Webhooks

  • Create a new Webhook

  • Update an existing Webhook

    • Update a single Webhook by it's ID

    • Update a list of Webhooks of particular IDs

  • Delete a Webhook from the database

    • Delete a single Webhook by it's ID

    • Delete a list of Webhooks of particular IDs

• Receive a Webhook

• Handle Response