search

mendix / docs

Mendix documentation repository
https://docs.mendix.com
Creative Commons Attribution 4.0 International
140 stars 719 forks source link

webhooks #6101

Open Michiel-Bijlsma opened 1 year ago

Michiel-Bijlsma commented 1 year ago

Please use the form below, leaving the prefilled data to help us. Thank you.

Page link: webhooks

Document link: webhooks.md

My Issue/Suggestion

I think it would be nice to include https://marketplace.mendix.com/link/component/119821 into the documentation. Especially in the part of Mendix (3.1.1) when you start validating a webhook without explaining how to setup a Pubished Rest Service (included in this module).

Adam-Dupaski commented 1 year ago

Hi @Michiel-Bijlsma thanks for the feedback. That component is only community-supported, despite being produced by Mendix, and it is not in our maintenance policy to document community-supported components. However, there may be some relevance for an exception here. @MarkvanMents what do you think?

MarkvanMents commented 1 year ago

Hi Michiel, We are talking about two completely different things here.

The webhooks in the document you reference are a way of triggering actions when certain events happen on the Mendix Platform (currently only two events, but there are plans to expand these if customers start using them). The webhook payload is generated by the Mendix Platform and sent to the specified URL. There is no need to customers to publish any REST services. They can (are advised to) validate that the trigger does come from the Mendix Platform, and that is what section 3.1 is all about.

The module you refer to is for customers to add to their own Mendix apps so that their app can trigger actions when certain events happen. The module (or the customer) is then in charge of ensuring that the endpoint can validate that the webhook comes from the app and hasn't been generated maliciously by a third-party. As Adam says, we do not document modules which are not platform-supported. If you have any suggestions regarding the Webhook Producer module you can raise an issue in the related GitHub repo.

Hope that makes sense. Let me know if you have any other questions.

Yours Mark

Michiel-Bijlsma commented 1 year ago

Hello Adam and Mark,

Thanks for your message!

I think I misunderstood the module, I didn't realize it was producing webhooks instead of consuming them. That makes my suggestion to add it a bit silly!

So let's change my input: section 3.1.1 talks about a flow that retrieves a list of Ststem.HttpHeader (step 2). But it doesn't tell how this flow is being called by the Mendix webhooks. I expect there should be some REST service in (my) Mendix app that will call this flow in 3.1.1. but that's not documented. Is this something that can be added to the documentation?

Thanks a lot! Michiel

MarkvanMents commented 1 year ago

That's a good idea. I'll pick this up and let you know when I've done it. Thanks, Mark.

katarzyna-koltun-mx commented 1 year ago

Thank you for reporting the issue! I've reached out to dev team for feedback. You'll get a notification when the issue is resolved.