Skip to content

docs(webhook): describe the package as using webhooks on the Slack Platform - #2858

Merged
mwbrooks merged 1 commit into
mainfrom
docs-webhook-description
Nov 17, 2026
Merged

mwbrooks merged 1 commit into
mainfrom
docs-webhook-description

Conversation

@zimeg

@zimeg zimeg commented Nov 17, 2026

Copy link
Copy Markdown
Member

Summary

This pull request updates the @slack/webhook package description to cover both kinds of webhook it sends to, since the package has helpers for Incoming Webhooks and Workflow Builder webhook triggers:

- "description": "Official library for using the Slack Platform's Incoming Webhooks",
+ "description": "Official library for using webhooks on the Slack Platform",

The new description shows on npm with the next @slack/webhook release.

Requirements

🤖 Generated with Claude Code

…atform

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg requested a review from a team as a code owner November 17, 2026 01:40
@zimeg zimeg added this to the webhook@next milestone Nov 17, 2026
@zimeg zimeg added docs M-T: Documentation work only pkg:webhook applies to `@slack/webhook` labels Nov 17, 2026
@zimeg zimeg self-assigned this Nov 17, 2026
@changeset-bot

changeset-bot Bot commented Nov 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3902377

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov

codecov Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.47%. Comparing base (fd8f6dd) to head (3902377).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2858      +/-   ##
==========================================
+ Coverage   94.25%   94.47%   +0.22%     
==========================================
  Files          67       67              
  Lines       10808    10808              
  Branches      680      683       +3     
==========================================
+ Hits        10187    10211      +24     
+ Misses        590      570      -20     
+ Partials       31       27       -4     
Flag Coverage Δ
cli-hooks 94.26% <ø> (+0.08%) ⬆️
cli-test 94.26% <ø> (+0.08%) ⬆️
logger 94.26% <ø> (+0.08%) ⬆️
oauth 94.26% <ø> (+0.08%) ⬆️
socket-mode 94.26% <ø> (+0.08%) ⬆️
web-api 94.26% <ø> (+0.08%) ⬆️
webhook 94.26% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mwbrooks mwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

✅ Thanks @zimeg! Nice to have the npm description cover the webhook triggers too, not just Incoming Webhooks.

"name": "@slack/webhook",
"version": "8.0.2",
"description": "Official library for using the Slack Platform's Incoming Webhooks",
"description": "Official library for using webhooks on the Slack Platform",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

suggestion (non-blocking): The @slack/webhook rows in AGENTS.md and the root README.md still describe it as Incoming Webhooks only. Could be a quick follow-up so they match this.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

📝 Opened #2861 for these!

@mwbrooks
mwbrooks merged commit 6fc548b into main Nov 17, 2026
22 checks passed
@mwbrooks
mwbrooks deleted the docs-webhook-description branch November 17, 2026 01:52
@zimeg

zimeg commented Nov 17, 2026

Copy link
Copy Markdown
Member Author

🌟 Thanks for the kind review @mwbrooks!

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

Labels

docs M-T: Documentation work only pkg:webhook applies to `@slack/webhook`

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants