Installations
npm install @slack/loggerReleases
@slack/socket-mode@2.0.3-rc.1
Published on 26 Nov 2024
@slack/cli-hooks@1.1.2
Published on 22 Nov 2024
@slack/cli-test@2.0.0+cli.2.30.1
Published on 04 Nov 2024
@slack/web-api@7.7.0
Published on 23 Oct 2024
@slack/web-api@7.6.0
Published on 08 Oct 2024
@slack/cli-test@1.3.0+cli.2.29.2
Published on 02 Oct 2024
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
>= 18
Typescript Support
Yes
Node Version
20.2.0
NPM Version
9.6.6
Statistics
3,279 Stars
2,546 Commits
662 Forks
122 Watching
48 Branches
183 Contributors
Updated on 25 Nov 2024
Bundle Size
1.12 kB
Minified
543.00 B
Minified + Gzipped
Languages
TypeScript (90.05%)
JavaScript (9.72%)
Ruby (0.17%)
Shell (0.06%)
Total Downloads
Cumulative downloads
Total Downloads
226,738,280
Last day
-12.2%
418,209
Compared to previous day
Last week
-0.1%
2,395,258
Compared to previous week
Last month
8%
10,216,393
Compared to previous month
Last year
85.9%
104,287,128
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Node Slack SDK
Getting Started
Visit the documentation site for all the lovely details.
This SDK is a collection of single-purpose packages. The packages are aimed at making building Slack apps easy, performant, secure, and scalable. They can help with just about anything in the Slack platform, from dropping notifications in channels to fully interactive bots.
The Slack platform offers several APIs to build apps. Each Slack API delivers part of the capabilities from the platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of Slack's APIs. They are small and powerful when used independently, and work seamlessly when used together, too.
Just starting out? The Getting Started tutorial will walk you through building your first Slack app using Node.js.
| Slack API | What its for | NPM Package |
|---|---|---|
| Web API | Send data to or query data from Slack using any of over 220 methods. | @slack/web-api |
| OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | @slack/oauth |
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | @slack/webhook |
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. | @slack/socket-mode |
Not sure about which APIs are right for your app? Read our blog post that explains the options. If you're still not sure, reach out for help and our community can guide you.
Deprecation Notice
@slack/events-api and @slack/interactive-messages officially reached EOL on May 31st, 2021. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed.
At this time, we recommend migrating to Bolt for JavaScript, a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some migration samples for those looking to convert their existing apps.
Installation
Use your favorite package manager to install any of the packages and save to your package.json:
1$ npm install @slack/web-api @slack/socket-mode 2 3# Or, if you prefer yarn 4$ yarn add @slack/web-api @slack/socket-mode
Usage
The following examples summarize the most common ways to use this package. There's also a Getting Started tutorial that's perfect for just starting out, and each package's documentation, linked in the table above.
Posting a message with Web API
Your app will interact with the Web API through the WebClient object, which is an export from @slack/web-api. You
typically instantiate a client with a token you received from Slack. The example below shows how to post a message into
a channel, DM, MPDM, or group. The WebClient object makes it simple to call any of the over 130 Web API
methods.
1const { WebClient } = require('@slack/web-api'); 2 3// An access token (from your Slack app or custom integration - xoxp, xoxb) 4const token = process.env.SLACK_TOKEN; 5 6const web = new WebClient(token); 7 8// This argument can be a channel ID, a DM ID, a MPDM ID, or a group ID 9const conversationId = 'C1232456'; 10 11(async () => { 12 // See: https://api.slack.com/methods/chat.postMessage 13 const res = await web.chat.postMessage({ channel: conversationId, text: 'Hello there' }); 14 15 // `res` contains information about the posted message 16 console.log('Message sent: ', res.ts); 17})();
Note: To use the example above, the token is required to have either the bot, chat:user:write, or
chat:bot:write scopes.
Tip: Use the Block Kit Builder for a playground where you can prototype your message's look and feel.
Listening for an event with the Events API
Refer to Bolt for JavaScript document pages.
Responding to interactive messages
Refer to Bolt for JavaScript document pages.
Using Socket Mode
Refer to the module document page and Bolt for JavaScript document page.
Requirements
This package supports Node v14 and higher. It's highly recommended to use the latest LTS version of node, and the documentation is written using syntax and features from that version.
Getting Help
If you get stuck, we're here to help. The following are the best ways to get assistance working through your issue:
- Issue Tracker for questions, feature requests, bug reports and general discussion related to these packages. Try searching before you create a new issue.
- Email us in Slack developer support:
developers@slack.com
No vulnerabilities found.
Reason
30 commit(s) and 7 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 13/21 approved changesets -- score normalized to 6
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci-build.yml:1
- Warn: no topLevel permission defined: .github/workflows/docs-deploy.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-build.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/ci-build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-build.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/ci-build.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-build.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/ci-build.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-build.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/ci-build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs-deploy.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/docs-deploy.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs-deploy.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/docs-deploy.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs-deploy.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/docs-deploy.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs-deploy.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/docs-deploy.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/triage-issues.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/slackapi/node-slack-sdk/triage-issues.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: examples/oauth-v2/link.sh:6
- Warn: npmCommand not pinned by hash: examples/oauth-v2/link.sh:10
- Warn: npmCommand not pinned by hash: examples/oauth-v2/unlink.sh:4
- Warn: npmCommand not pinned by hash: examples/openid-connect/link.sh:6
- Warn: npmCommand not pinned by hash: examples/openid-connect/link.sh:10
- Warn: npmCommand not pinned by hash: packages/socket-mode/examples/link.sh:6
- Warn: npmCommand not pinned by hash: packages/socket-mode/examples/link.sh:10
- Warn: npmCommand not pinned by hash: prod-server-integration-tests/link-socket-mode.sh:7
- Warn: npmCommand not pinned by hash: prod-server-integration-tests/link-socket-mode.sh:14
- Warn: npmCommand not pinned by hash: prod-server-integration-tests/link-web-api.sh:7
- Warn: npmCommand not pinned by hash: prod-server-integration-tests/link-web-api.sh:14
- Warn: npmCommand not pinned by hash: scripts/generate-web-api-types.sh:18
- Warn: npmCommand not pinned by hash: scripts/generate-web-api-types.sh:25
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:36
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:43
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:44
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:44
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:45
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:45
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:46
- Warn: npmCommand not pinned by hash: .github/workflows/ci-build.yml:46
- Info: 0 out of 7 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 1 out of 22 npmCommand dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 29 are checked with a SAST tool
Reason
10 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Score
4.4
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More