repository·main·Indexed 25 days ago
https://github.com/slackapi/node-slack-sdkA collection of modular, single-purpose packages for building Slack apps, providing direct access to the Web API, OAuth, Webhooks, and Socket Mode. Includes specialized packages such as @slack/oauth for managing installation flows, @slack/rtm-api for Real Time Messaging, @slack/cli-test and @slack/cli-hooks for Slack CLI automation and integration, and @slack/logger for standardized logging.
The @slack/oauth package simplifies the OAuth flow for Slack apps. It supports both V2 OAuth for modern Slack Apps and V1 OAuth for legacy Classic Slack apps. It is designed for apps installed in multiple workspaces (e.g., Slack Marketplace or Enterprise Grid) and handles:
The Node Slack SDK provides specialized packages for different Slack APIs. Use the package that matches your specific use case:
@slack/web-api to send data to or query data from Slack using over 200 methods.@slack/oauth to set up the V2 OAuth authentication flow for Slack apps.@slack/webhook to send notifications to a specific channel.@slack/socket-mode to listen for incoming messages and events via WebSocket.Note: @slack/events-api and @slack/interactive-messages have reached End of Life (EOL). It is recommended to migrate to Bolt for JavaScript for these functionalities.
The @slack/rtm-api package provides a client for interacting with Slack's legacy Real Time Messaging API via a persistent Websocket connection.
Important Compatibility Note: The RTM API is not available for modern granular-permissions apps. If you are building a new app, Slack recommends using Bolt for JavaScript. If you have an existing RTM app, do not update its scopes, as converting it to a granular-permissions app will cause it to stop working with the RTM API.
The SDK provides dedicated packages for different Slack APIs. Choose the package that matches your integration needs:
| Slack API | Use Case | NPM Package |
|---|---|---|
| Web API | Send data to or query data from Slack using over 270 methods. | @slack/web-api |
| OAuth | Set up V2 OAuth (for Slack apps) or V1 OAuth (for classic apps) authentication flows. | @slack/oauth |
| Incoming Webhooks | Send notifications to a single channel selected by the user during installation. | @slack/webhook |
| Socket Mode | Listen for incoming messages and a limited set of events using WebSockets. | @slack/socket-mode |
The ChatStreamer class allows you to create a continuous chat stream, enabling you to append content incrementally to a single message. This is useful for long-running or generative text responses.
To use it, you can either instantiate it directly via new ChatStreamer(...) or use the convenience method client.chatStream(...) provided by the WebClient.
channel, thread_ts, recipient_team_id, and recipient_user_id..append() multiple times to add content (e.g., markdown_text)..stop() to finalize the message and end the stream.const streamer = client.chatStream({
channel: "C0123456789",
thread_ts: "1700000001.123456",
recipient_team_id: "T0123456789",
recipient_user_id: "U0123456789",
});
await streamer.append({
markdown_text: "**hello wo",
});
await streamer.append({
markdown_text: "rld!**",
});
await streamer.stop();@slack/oauth package requires Node.js v14 or higher. It is highly recommended to use the latest LTS version of Node.js.When using the socket-mode-app.manifest.json, you must manually generate an app-level token (xapp-) with the connections:write scope.
Steps:
SLACK_SDK_TEST_SOCKET_MODE_APP_TOKEN environment variable.Install the Slack Real Time Messaging (RTM) API client using npm to enable persistent Websocket connections for receiving events and sending simple messages.
$ npm install @slack/rtm-apiInstall the @slack/web-api package using npm to access Slack's Web API via a configurable HTTP client. This package handles method formatting, queuing, retrying, and pagination.
$ npm install @slack/web-apiThe v8 release of @slack/web-api replaces axios with the native Fetch API (globalThis.fetch).
Key Requirements & Changes:
axios, form-data, is-electron, and is-stream.agent, tls, requestInterceptor, and adapter options with a single fetch option.Error subclasses (e.g., WebAPIPlatformError, WebAPIRequestError) instead of interfaces. It is recommended to use instanceof for error checking.npm i @slack/web-apiWhen upgrading from @slack/socket-mode v1.x to v2.x, you must address breaking changes regarding lifecycle events and client properties.
authenticated: Use connected to detect when the client has established a connection and received a hello message (events will start flowing after this), or use connecting if you need to be notified before the connection is established.unable_to_socket_mode_start: Use the error event, or reconnecting if you have client reconnections enabled.connected and authenticated have been removed.isActive(): Call this method on the client to determine if the WebSocket connection powering the client is healthy.The Node Slack SDK follows a support schedule tied to Node.js LTS (Long Term Support) version maintenance cycles. You are supported at least until the maintenance for your current Node.js LTS version ends, which typically occurs every 12 months.
To ensure a smooth transition between major versions, the maintainers follow these commitments:
Migration Planning Tip: If a newer major version of the Node SDK is available, plan your migration early. Some updates may only be released for the newest major versions.