Skip to content

Mention Smee security caveat and alternatives on Testing webhooks - #46520

Merged
mchammer01 merged 3 commits into
github:mainfrom
samcrichard:webhooks-testing-alternatives
Nov 10, 2026
Merged

mchammer01 merged 3 commits into
github:mainfrom
samcrichard:webhooks-testing-alternatives

Conversation

@samcrichard

Copy link
Copy Markdown
Contributor

Why:

"Testing webhooks" walks through smee.io but, unlike "Using webhooks with GitHub Apps", doesn't mention that Smee channels are unauthenticated or that other tools can be used to receive webhooks locally.

What's being changed:

Adds one paragraph after the smee.io intro, reusing the wording already in
content/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps.md
so the two pages are consistent.

Disclosure: I work at ngrok, one of the tools listed. The list and links are copied unchanged from the existing GitHub Apps page.

Check off the following:

  • I have reviewed my changes in staging.
  • For content changes, I have completed the self-review checklist.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
webhooks/testing-and-troubleshooting-webhooks/testing-webhooks.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Oct 28, 2026
@subatoi

subatoi commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

@samcrichard Thanks for raising a PR. To set expectations appropriately, it's rare that we'd change established documentation when it concerns a third-party provider. However, in this case I think it warrants at least a re-review from the relevant team. I can't guarantee a timeframe for their response, but I've marked the PR accordingly to add it to their queue.

@subatoi subatoi added content This issue or pull request belongs to the Docs Content team driver persona and removed triage Do not begin working on this issue until triaged by the team labels Oct 28, 2026
@samcrichard

Copy link
Copy Markdown
Contributor Author

Thank you!

fajarr2547-pixel

This comment was marked as spam.

@mchammer01 mchammer01 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@samcrichard 👋🏻 - thanks for improving our documentation ✨
LGTM :shipit:

@mchammer01
mchammer01 enabled auto-merge November 10, 2026 09:50
Copilot AI lite review requested due to automatic review settings November 10, 2026 09:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are present, and the documentation changes clearly communicate Smee’s security limitation and suitable alternatives.

No open issues 🎉

What changed in this PR

This PR improves the webhook testing documentation by warning readers about Smee's unauthenticated channels and providing alternative tools for receiving webhook payloads locally.

Changes:

  • Warns that Smee is intended only for development and testing because channels are unauthenticated.
  • Lists ngrok, localtunnel, and Hookdeck Console as alternative webhook forwarding tools.
  • Explains that alternative tools provide a public webhook URL and allow readers to skip Smee-specific steps.
File Description
content/​webhooks/​testing-and-troubleshooting-webhooks/​testing-webhooks.md Adds the Smee security caveat and documents alternative tools for forwarding webhook payloads to a local environment.

Review effort: Lite

@mchammer01
mchammer01 added this pull request to the merge queue Nov 10, 2026
Merged via the queue into github:main with commit a95a447 Nov 10, 2026
61 of 100 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team driver persona

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants