[16.0][ADD] webhook_outgoing: send outgoing webhooks #13

hoangtrann · 2024-07-26T09:56:50Z

No description provided.

rvalyi · 2024-07-26T12:33:50Z

Great! Using queue job also seems interesting. I didn't dig deeply into the review yet though, but I might use it and help.

For reference here is the webhook code In Odoo 17.0+ CE (so not available on Odoo 16.0)
https://github.com/odoo/odoo/blob/master/addons/base_automation/models/base_automation.py#L98

(usage can be seen here https://medium.com/@karan.bk/simplify-integration-with-odoo-17-using-webhooks-4ec56c46fcb3)
This is not a lot of code; eventually there are some ideas to get, eventually some sort of compatibility can be achieved.

EDIT: to achieve some kind of compatibility, from a quick overview:

it looks like the webhook.consumer object of this PR could be merged into the Odoo base.automation object from base_automation. Fields can be made the same.
base_automation don't use queue job, so eventually, this would be a great addition from this extra OCA module.
the ir.actions.server override here is minimal just like it is minimal in base_automation, so we could easily ensure it works closely enough: https://github.com/odoo/odoo/blob/master/addons/base_automation/models/ir_actions_server.py#L54
In this PR calls are logged in a new object called webhook.logging while in base_automation, the log object is ir.logging that is available at least since Odoo v14: https://github.com/odoo/odoo/blob/16.0/odoo/addons/base/models/ir_logging.py

cc @pedrobaeza @sebastienbeau @hparfr @sbidoul @lmignon @simahawk @etobella

rvalyi · 2024-07-26T13:36:05Z

there is also possibly some overlap with https://github.com/OCA/web-api/blob/14.0/webservice/models/webservice_backend.py from the https://github.com/OCA/web-api/tree/14.0 OCA project. In any case, quick and dirty web hooks with no code is certainly something important to have for simple and quick automation.

rvalyi · 2024-07-26T19:39:32Z

it can also be installed as an option, but eventually this server_action_logging module might help.

rvalyi · 2024-07-29T13:43:49Z

BTW, @gurneyalex pointed that the security of the native Odoo v17 web hooks is probably not so good: https://x.com/gurneyalex/status/1817900552329560150 ...

So good if this extra module could bring some real security... Is it safe now https://github.com/OCA/webhook/pull/13/files#diff-ca6b9e897fddbb1f998aefd239a9630cef55fbdcd6de7a2b20043e2faff24b29R28 ?

Eventually, we might use base_rest_auth_api_key https://github.com/OCA/rest-framework/tree/16.0/base_rest_auth_api_key may be ?

ivs-cetmix · 2024-08-05T20:08:29Z

@hoangtrann @rvalyi looks like `codecov/project' action is still running. It will consume tons of minutes

ivs-cetmix · 2024-08-05T20:23:58Z

also @sbidoul please have a look at the codecove job here

hoangtrann · 2024-08-06T12:50:39Z

@ivs-cetmix force push to trigger actions seem to solve the issue

ivs-cetmix

Thank you once again for your contribution. Some thoughts here:

Probably the first module should be named something like webhook_outgoing for better matching the module designation. Same for the module name and description
Maybe it would be better to have 2 different PR's per module. You can add dependencies in the second PR using test-requirements.txt. This will make reviews and merging modules faster
Test coverage is something that is a must so tests should be added in order to proceed further
Same with documentation. However this is something we can also assist with

webhook_base/__manifest__.py

webhook_base/models/ir_action_server.py

webhook_incoming/__manifest__.py

hoangtrann · 2024-08-26T20:33:36Z

thanks @ivs-cetmix @rvalyi for your feedback, I've updated the PR to only include the webhook_outgoing for sending out webhook requests.

I've made changes accordingly as well:

Merge with ir.actions.server, all fields are brought to this model
I'd like to keep webhook.logging for now to log information that we can relate directly to the webhook

I'm going to update the tests as well as creating another PR for incoming webhook

agent-z28 · 2024-11-11T21:10:04Z

@hoangtrann lets get it merged ! it's really great.

lmignon

Thank you for this addons. Can you add tests plz? Unittest are required to ensure code quality and maintainability.

hoangtrann · 2025-01-11T15:47:21Z

@lmignon I've added tests, sorry that it takes a while though

hoangtrann · 2025-01-11T16:11:59Z

ping @ivs-cetmix @rvalyi as well for review

hoangtrann · 2025-03-21T13:23:19Z

@OCA/tools-maintainers appreciate some reviews here

rvalyi · 2025-03-21T14:00:20Z

EDIT: hum, this PR is now only for the outgoing webhooks, so there is no such overlap issue here as I initially mentioned below here...

@simahawk @etobella @LoisRForgeFlow @lmignon @pedrobaeza @ivs-cetmix how do you guys see these modules here fit together with https://github.com/OCA/web-api (specially the endpoint and webservice API), seems there is some overlap for a webhook server. This proposal here is however closer to the Odoo native webhook thing that comes at v17+.

Ideally we don't duplicate efforts. But I didn't investigate too much if the webhook server here would still make sense or if convergence/compatibility is somewhat possible...

ivs-cetmix · 2025-03-21T14:06:06Z

@simahawk @etobella @LoisRForgeFlow @lmignon @pedrobaeza @ivs-cetmix how do you guys see these modules here fit together with https://github.com/OCA/web-api (specially the endpoint and webservice API), seems there is some overlap for a webhook server. This proposal here is however closer to the Odoo native webhook thing that comes at v17+.

Ideally we don't duplicate efforts. But I didn't investigate too much if the webhook server here would still make sense or if convergence/compatibility is somewhat possible...

I would partially agree with you, as the endpoint module does the job for us as an incoming web hook.
I think it would be more reasonable to put efforts towards improving the existing modules rather than creating a semi-copies of them in different repos.
One of the options could be to build a webhook repo modules as a wraparound over the web-api ones.
@hoangtrann

rvalyi · 2025-03-21T14:08:07Z

@ivs-cetmix I'm sorry I just found out that the scope of this PR changed and as for now only the webhook_outgoing module is proposed for review. So my previous comment was not pertinent anymore (I added an EDIT line).

hoangtrann · 2025-03-21T17:08:33Z

Yup I've separated this PR and made another one for incoming webhooks for ease of review. The major features this bring are render payload using Jinja template and execute using queue job. This allows user to quickly build an integration to send custom Slack notification for example.

webhook_outgoing/models/ir_action_server.py

hoangtrann · 2025-12-27T06:54:28Z

@lmignon @ivs-cetmix I've addressed the changes. Would love to get this merge and I will forward the changes to newer versions.

@rrebollo force push seems to fix the runbot, you can now test this on the runbot rather than the 17.0 version since it's outdated.

rrebollo · 2025-12-28T14:01:01Z

@hoangtrann the PR name should be something along "[16.0][ADD] webhook_outgoing: ...."

ivs-cetmix

So far looks good, thank you!

Important notice: please structure the module documentation according to the OCA documentation layout: https://github.com/OCA/maintainer-tools/tree/master/template/module/readme
I would recommend to use .md format for docs as it's better from both readability and maintenance perspective.

ivs-cetmix · 2025-12-29T10:06:07Z

webhook_outgoing/models/ir_action_server.py

+        :return str headers: headers object in string format
+        """
+        self.ensure_one()
+        headers = dict(json.loads(self.headers.strip())) if self.headers else {}


Non an issue but a question: json.loads() returns a dict, is there an actual need for another dict() operator?

yeah let me make an update for this

I've updated the doc and make change to eval the headers. Since headers is just text, save_eval is used to handle both case if headers is a python dict or it's a json

etobella · 2025-12-29T10:20:28Z

webhook_outgoing/models/ir_action_server.py

+        """
+        self.ensure_one()
+        headers = dict(json.loads(self.headers.strip())) if self.headers else {}
+        return str(headers)


actually, you are doing from text to dict (json.loads), then dict to str (str) and again str to dict with safe_eval, maybe you could simplify that....

yeah I must be handling something at that point which I now totally forgot, let me simplify it

I've made the update, since headers is just text, save_eval is used to handle both case if headers is a python dict or it's a json.

hoangtrann force-pushed the 16.0_add-webhook-modules branch from 28220c0 to 208010b Compare July 26, 2024 10:41

hoangtrann changed the title ~~[ADD] webhook_(base,incoming): receive and send webhooks~~ [WIP] webhook_(base,incoming): receive and send webhooks Jul 26, 2024

hoangtrann changed the title ~~[WIP] webhook_(base,incoming): receive and send webhooks~~ [IMP] webhook_(base,incoming): receive and send webhooks Aug 6, 2024

hoangtrann force-pushed the 16.0_add-webhook-modules branch from 208010b to 5d832a1 Compare August 6, 2024 12:36

ivs-cetmix requested changes Aug 26, 2024

View reviewed changes

webhook_base/__manifest__.py Outdated Show resolved Hide resolved

webhook_base/models/ir_action_server.py Outdated Show resolved Hide resolved

webhook_incoming/__manifest__.py Outdated Show resolved Hide resolved

hoangtrann force-pushed the 16.0_add-webhook-modules branch from 5d832a1 to a03cb3d Compare August 26, 2024 20:26

hoangtrann changed the title ~~[IMP] webhook_(base,incoming): receive and send webhooks~~ [IMP] webhook_outgoing: send outgoing webhooks Aug 26, 2024

hoangtrann force-pushed the 16.0_add-webhook-modules branch from a03cb3d to 59c9c13 Compare September 17, 2024 17:51

lmignon requested changes Nov 12, 2024

View reviewed changes

hoangtrann force-pushed the 16.0_add-webhook-modules branch 2 times, most recently from 801e35e to 086853a Compare January 11, 2025 15:44

paulius-sladkevicius reviewed Apr 29, 2025

View reviewed changes

webhook_outgoing/models/ir_action_server.py Outdated Show resolved Hide resolved

hoangtrann mentioned this pull request Oct 25, 2025

[ADD][17.0] webhook_outgoing: send outgoing webhook requests #15

Open

rrebollo mentioned this pull request Nov 30, 2025

[16.0][ADD] billcom_integration OCA/l10n-usa#166

Open

hoangtrann force-pushed the 16.0_add-webhook-modules branch from 086853a to b52ded6 Compare December 27, 2025 06:49

hoangtrann changed the title ~~[IMP] webhook_outgoing: send outgoing webhooks~~ [16.0][ADD] webhook_outgoing: send outgoing webhooks Dec 29, 2025

ivs-cetmix requested changes Dec 29, 2025

View reviewed changes

etobella reviewed Dec 29, 2025

View reviewed changes

[ADD] webhook_outgoing: send outgoing webhook requests

fa92a21

hoangtrann force-pushed the 16.0_add-webhook-modules branch from b52ded6 to fa92a21 Compare December 29, 2025 10:58

Uh oh!

[16.0][ADD] webhook_outgoing: send outgoing webhooks #13

Are you sure you want to change the base?

[16.0][ADD] webhook_outgoing: send outgoing webhooks #13

Uh oh!

Conversation

hoangtrann commented Jul 26, 2024

Uh oh!

rvalyi commented Jul 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rvalyi commented Jul 26, 2024

Uh oh!

rvalyi commented Jul 26, 2024

Uh oh!

rvalyi commented Jul 29, 2024

Uh oh!

ivs-cetmix commented Aug 5, 2024

Uh oh!

ivs-cetmix commented Aug 5, 2024

Uh oh!

hoangtrann commented Aug 6, 2024

Uh oh!

ivs-cetmix left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hoangtrann commented Aug 26, 2024

Uh oh!

agent-z28 commented Nov 11, 2024

Uh oh!

lmignon left a comment

Choose a reason for hiding this comment

Uh oh!

hoangtrann commented Jan 11, 2025

Uh oh!

hoangtrann commented Jan 11, 2025

Uh oh!

hoangtrann commented Mar 21, 2025

Uh oh!

rvalyi commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ivs-cetmix commented Mar 21, 2025

Uh oh!

rvalyi commented Mar 21, 2025

Uh oh!

hoangtrann commented Mar 21, 2025

Uh oh!

Uh oh!

hoangtrann commented Dec 27, 2025

Uh oh!

rrebollo commented Dec 28, 2025

Uh oh!

ivs-cetmix left a comment

Choose a reason for hiding this comment

Uh oh!

ivs-cetmix Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

hoangtrann Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

hoangtrann Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

etobella Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

hoangtrann Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

hoangtrann Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

rvalyi commented Jul 26, 2024 •

edited

Loading

rvalyi commented Mar 21, 2025 •

edited

Loading