Skip to content

Improve Webhooks Documentation with Additional Context and Examples #4775

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

selvaganesh0355
Copy link

  1. Adding detailed explanations for webhook configuration, signing, and verification.
  2. Including a comprehensive step-by-step guide for verifying webhook signatures.
  3. Providing a new example implementation in Node.js for handling webhooks.
  4. Introducing tools like Beeceptor and Pipedream for testing webhooks.
  5. Improving the flow and readability of the documentation for developers.

Copy link

netlify bot commented Apr 24, 2025

Deploy Preview for gallant-galileo-14878c ready!

Name Link
🔨 Latest commit 2a3c051
🔍 Latest deploy log https://app.netlify.com/sites/gallant-galileo-14878c/deploys/680a74f462f2030008340a14
😎 Deploy Preview https://deploy-preview-4775--gallant-galileo-14878c.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@tessalt
Copy link
Contributor

tessalt commented Apr 28, 2025

thanks for contributing these documentation improvements! We'll have to take some time to review this but it looks like a big improvement.

Comment on lines +124 to +126
- **[Beeceptor](https://beeceptor.com/)**: Quickly create a mock endpoint to inspect incoming webhook requests.
- **[Pipedream](https://pipedream.com/requestbin)**: Set up a request bin to capture and debug webhook payloads.
- **[TypedWebhook.tools](https://typedwebhook.tools/)**: Test and validate webhook payloads with schema validation.
Copy link
Contributor

Choose a reason for hiding this comment

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

considering the above example shows how to hook this up with a simple nodejs express script, why do we need to be including these tools into our documentation?

Inspecting http requests isn't complicated, tools like these are overkill for testing a webhook endpoint and I would not personally use any of them.

@selvaganesh0355
Copy link
Author

Hi @nick-funk, my intention was to help the developer community with the right set of tools for webhook testing. I firmly believe this would be useful for the documentation readers. Let me know your thoughts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants