Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated webhook docs for clarity #6683

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

arti-bol
Copy link

@arti-bol arti-bol commented Nov 20, 2024

Description

Added clarity for webhooks

Type of suggestion

  • Typo/grammar fix
  • Updated outdated content
  • New content
  • Updates related to a new version
  • Other

Product & version (if relevant)

@sofietoft
Copy link
Contributor

Thanks for the PR @arti-bol ! 💪

I'll make sure we get this reviewed by our Commerce team.
Could you take a look at the warnings in the article in the mean time?

@sofietoft sofietoft added the review/dteam Use this label if an internal D-team review is required label Nov 20, 2024
@arti-bol
Copy link
Author

I hope you meant the following:

 [
  {
    "message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).",
    "location": {
      "path": "commerce-add-ons/payment-providers/mollie/how-to-guides/testing-mollie-webhooks-locally.md",
      "range": {
        "start": {
          "line": 14,
          "column": 1
        }
      }
    },
    "severity": "WARNING"
  },
  {
    "message": "[UmbracoDocs.Editorializing] Consider removing 'easily'",
    "location": {
      "path": "commerce-add-ons/payment-providers/mollie/how-to-guides/testing-mollie-webhooks-locally.md",
      "range": {
        "start": {
          "line": 20,
          "column": 30
        }
      }
    },
    "severity": "WARNING"
  },
  {
    "message": "[UmbracoDocs.Editorializing] Consider removing 'various'",
    "location": {
      "path": "commerce-add-ons/payment-providers/mollie/how-to-guides/testing-mollie-webhooks-locally.md",
      "range": {
        "start": {
          "line": 22,
          "column": 208
        }
      }
    },
    "severity": "WARNING"
  },
  {
    "message": "[UmbracoDocs.Editorializing] Consider removing 'easy'",
    "location": {
      "path": "commerce-add-ons/payment-providers/mollie/how-to-guides/testing-mollie-webhooks-locally.md",
      "range": {
        "start": {
          "line": 23,
          "column": 102
        }
      }
    },
    "severity": "WARNING"
  }
]```

@arti-bol
Copy link
Author

Found these and addressed.

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of the warnings @arti-bol ! 😄
I've made a suggestion to also resolve the long sentence - let me know what you think!

…g-mollie-webhooks-locally.md

Co-authored-by: sofietoft <[email protected]>
@arti-bol
Copy link
Author

merged your suggestion, @sofietoft.

@sofietoft
Copy link
Contributor

Great, thanks @arti-bol ! 😄
One of our Commerce developer will be reviewing the changes soon as well 🙌

Copy link
Contributor

@umbracotrd umbracotrd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sofietoft : I just add one comment regarding the Beeceptor's pricing. The rest looks good to me.

With a local tunnel, you can test and debug Mollie webhooks without deploying your application to a live environment. Here are two popular tools to create a secure public URL for testing Mollie webhooks:

1. [Ngrok](https://ngrok.com/?utm_source=docs.umbraco.com) is a widely used tool that creates a secure tunnel from your local machine to a public URL. It supports advanced configurations and works well with webhook-based systems.
2. [Beeceptor’s Local Tunnel](https://beeceptor.com/local-tunnel/?utm_source=docs.umbraco.com) gives a public HTTP mock server that allows you to expose your local server to the internet securely. Supports HTTPs, mock rules and comes with request history.
Copy link
Contributor

@umbracotrd umbracotrd Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sofietoft: Beeceptor's free plan allows only 50 requests per day which is next to nothing in term of testing. I think it's up to you to decide whether you want to keep it in our docs or not.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arti-bol - What do you say about adding a little note/warning mentioning this limitation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category/umbraco-commerce review/dteam Use this label if an internal D-team review is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants