The Slack platform offers several APIs to build apps. Each Slack API delivers part of the capabilities from theplatform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each ofSlack’s APIs. They are small and powerful when used independently, and work seamlessly when used together, too.
Just starting out? The Getting Started tutorial willwalk 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 130 methods. | @slack/web-api |
| Events API | Listen for incoming messages and many other events happening in Slack, using a URL. | @slack/events-api |
| Interactive Messages | Respond to button clicks, dialogs, and other interactions with messages. | @slack/interactive-messages |
| OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | @slack/oauth |
| RTM API | Listen for incoming messages and a limited set of events happening in Slack, using websockets. | @slack/rtm-api |
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | @slack/webhook |
Not sure about which APIs are right for your app? Read our blogpost that explains the options.If you’re still not sure, reach out for help and our community can guide you.
If you’re looking for an all-in-one solution that hides the underlying Slack APIs, but simplifies building a bot-styleapp inside Slack, try the Hubot Slack adapter. Hubot is a popular frameworkfor internal apps that automate workflows, perform ChatOps, or just generate silly memes.
- We are no longer supporting this browser, so you’ll need to switch to one of our supported browsers to keep using Slack. We know this can be a pain, and we’re sorry for asking you to do it. We know this can be a pain, and we’re sorry for asking you to do it.
- Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Installation
Use your favorite package manager to install any of the packages and save to your package.json:
Requirements
Slack brings team communication and collaboration into one place so you can get more work done, whether you belong to a large enterprise or a small business. Check off your to-do list and move your projects forward by bringing the right people, conversations, tools, and information you need together. Slack brings team communication and collaboration into one place so you can get more work done, whether you belong to a large enterprise or a small business. Check off your to-do list and move your projects forward by bringing the right people, conversations, tools, and information you need together.
This package supports Node v8 LTS and higher. It’s highly recommended to use the latest LTS version ofnode, and the documentation is written using syntax and featuresfrom 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:
Slack Website Integration
- Issue Tracker for questions, featurerequests, bug reports and general discussion related to this package.
- Email us in Slack developer support:
developers@slack.com - Bot Developers Hangout: a Slack community for developersbuilding all types of bots. You can find the maintainers and users of this package in #sdk-node-slack-sdk.