Changelog

What’s Changed

For compatibility with node v19.5 and newer (including node v20+), it is recommended to update to this version as the WebSocket API changed slightly. In certain websocket failure modes, versions of rtm-api prior to 6.1.1 using node v19.5 or newer may see Cannot read properties of null (reading 'message') failures (see #1641 for an example).

• Update socket send errback by @cmbuckley in #1597

What’s Changed

• Fix bug with files.uploadV2 to ensure complete file is uploaded by @srajiang in https://github.com/slackapi/node-slack-sdk/pull/1616
• Add cursor pagination to team.accessLogs by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1625
• Mark stars.* API methods as deprecated by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1632
• chore: fix imports order by @levenleven in https://github.com/slackapi/node-slack-sdk/pull/1639
• feat: add context to rate-limited event by @levenleven in https://github.com/slackapi/node-slack-sdk/pull/1637
• Upgrade dependency to @slack/types by @ClementValot in https://github.com/slackapi/node-slack-sdk/pull/1559

New Contributors

• @levenleven made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1639
• @ClementValot made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1559

Full Changelog: https://github.com/slackapi/node-slack-sdk/compare/@slack/web-api@6.8.1…@slack/web-api@6.9.0

What’s Changed

• Improve the default OAuth page renderer not to embed any params as-is by @seratch https://github.com/slackapi/node-slack-sdk/pull/1604

Full Changelog: https://github.com/slackapi/node-slack-sdk/compare/@slack/oauth@2.6.0…@slack/oauth@2.6.1

What’s Changed

• Replace TSLint with ESLint by @filmaj in https://github.com/slackapi/node-slack-sdk/pull/1325
• Fix #1251 Upgrade the minimum version of “ws” package by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1322
• Update code to make it TS 4.4 compatible by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1319
• Publish @slack/rtm-api@6.1.0 by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1591
• Vulnerability in ws@5.2.3 by @gamboaa in https://github.com/slackapi/node-slack-sdk/issues/1590

Full Changelog: https://github.com/slackapi/node-slack-sdk/compare/@slack/rtm-api@6.0.0…@slack/rtm-api@6.1.0

What’s Changed

• Add include_categories to emoji.list API arguments by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1581
• feat: set default max concurrency to 100 for by @callumsteele4 in https://github.com/slackapi/node-slack-sdk/pull/1583 (fixes https://github.com/slackapi/node-slack-sdk/issues/1582)
• Use Readable instead of ReadStream in uploadV2 by @redneb in https://github.com/slackapi/node-slack-sdk/pull/1577 (fixes https://github.com/slackapi/node-slack-sdk/issues/1586)
• Add admin.conversations.bulk{Archive|Delete|Move} API method support by @seratch in https://github.com/slackapi/node-slack-sdk/issues/1566
• fix auth.revoke argument type definition (test should be optional) by @Cattttttttt in https://github.com/slackapi/node-slack-sdk/pull/1562

New Contributors

• @callumsteele4 made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1583
• @redneb made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1577

What’s Changed

Security

• Upgraded jsonwebtoken dependency for critical level security issues by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1575
• Fixed auth.revoke argument type definition by @Cattttttttt in https://github.com/slackapi/node-slack-sdk/pull/1562
• Added support for admin.conversations.bulk{Archive|Delete|Move} API method, by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1572

Docs

• Update docs to include files.uploadV2 by @srajiang in https://github.com/slackapi/node-slack-sdk/pull/1548
• Update maintainer’s guide to clarify release instructions by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1556

New Contributors

• @Cattttttttt made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1562 🎉, thank you!

Full Changelog: https://github.com/slackapi/node-slack-sdk/compare/@slack/web-api@6.8.0…@slack/oauth@2.6.0

What’s Changed

• Added in functionality for admin.analytics.getFile method by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1515
• avoid creating unnecessary function by @jimmywarting in https://github.com/slackapi/node-slack-sdk/pull/1524
• Add include_all_metadata to conversations.replies API arguments by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1537
• Add files.uploadv2 support (fixing #1541) by @srajiang in https://github.com/slackapi/node-slack-sdk/pull/1544
• fix(1528): better warnings about webclient fallbacks by @edwmurph in https://github.com/slackapi/node-slack-sdk/pull/1529
• ChatUnfurlArguments require either channel and ts or unfurl_id and source properties to be specified in pairs by @filmaj in https://github.com/slackapi/node-slack-sdk/pull/1551

New Contributors

• @jimmywarting made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1524
• @edwmurph made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1529

Full Changelog: https://github.com/slackapi/node-slack-sdk/compare/@slack/web-api@6.7.2…@slack/web-api@6.8.0

What’s Changed

• Fix #1512 Add video block to Block Kit support by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1514
• Add types for DateTimepicker, EmailInput, NumberInput and URLInput by @filmaj in https://github.com/slackapi/node-slack-sdk/pull/1549

Full Changelog: https://github.com/slackapi/node-slack-sdk/compare/@slack/types@2.7.0…@slack/types@2.8.0

What’s Changed

• Always handle web socket open when connecting by @WilliamBergamin in https://github.com/slackapi/node-slack-sdk/pull/1522
• Fix #1546 SocketModeClient raise TypeError when running Node.js 19 by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1547

What’s Changed

• Add interactivity pointer by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1526
• Publish by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1533
• Update maintainer’s guide to add more specific instructions for releases by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1511
• Add types module to issue templates by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1513
• Fix #1512 Add video block to Block Kit support by @seratch in https://github.com/slackapi/node-slack-sdk/pull/1514
• Added in functionality for admin.analytics.getFile method by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1515
• Update @slack/client README to reflect deprecation by @hello-ashleyintech in https://github.com/slackapi/node-slack-sdk/pull/1519
• Always handle web socket open when connecting by @WilliamBergamin in https://github.com/slackapi/node-slack-sdk/pull/1522
• avoid creating unnecessary function by @jimmywarting in https://github.com/slackapi/node-slack-sdk/pull/1524
• Bump lerna dependency by @srajiang in https://github.com/slackapi/node-slack-sdk/pull/1532

New Contributors

• @WilliamBergamin made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1522
• @jimmywarting made their first contribution in https://github.com/slackapi/node-slack-sdk/pull/1524

This release is a beta release and is not production ready. Full Changelog: https://github.com/slackapi/node-slack-sdk/compare/@slack/oauth@2.5.4…@slack/web-api@6.7.2-nextGen.1

• #1502 Add timezone property to Timepicker block element (via #1503) - thanks @hello-ashleyintech !

See the full list of issues/pull requests of this release here.

• Fix #1506: handleInstallPath throws an error when stateVerification is false (via #1507) - thanks @rockingskier !

See the full list of issues/pull requests of this release here.

• #1504 Adding Message Metadata support - thanks @dannyhostetler !

See the full list of issues/pull requests of this release here.

• Improve InstallationProvide logic not to save new data when token rotation is enabled plus the tokens are not refreshed (via #1497 ) - thanks @omermizr!

See the full list of issues/pull requests of this release here.

• #1496 Fix #1495 SocketModeClient still fails to automatically reconnect when apps.connections.open API returns an error code - Thanks @seratch @levenleven

See the full list of issues/pull requests of this release here.

• Add domain to team.info API parameters (via #1457) - thanks @seratch
• Fix #1490 Add missing properties to UsersInfoResponse (via #1491) - thanks @seratch @AdriannaBeck
• #1476 Tweaking logic for warning when using conversation APIs that are missing accessibility parameters (via #1479) - thanks @filmaj @saveman71

See the full list of issues/pull requests of this release here.

• #1478: Add accessibility_label field to Button interface - thanks @kpeters-cbsi !
• #1462: Add app unfurl related properties in attachments (fixed via #1463) - thanks @seratch !

See the full list of issues/pull requests of this release here.

• Fix a bug where additional cookies set by beforeRedirection are overwritten (via #1485 ) - thanks @seratch!

See the full list of issues/pull requests of this release here.

• #1465 #1470 Fix #1243 #1464 Socket Mode reconnection issue - Thanks @seratch @Zenexer @kyman2001
• #1456 Fix #1455 bolt-js’s ack(string) does not work in Socket Mode - Thanks @seratch
• #1459 Fix #1450 Add isActive property to the SocketModeClient - Thanks @seratch
• #1467 Split SocketModeClient.ts into several files - Thanks @seratch
• #1466 Add envelope_id to Socket Mode listener arguments - Thanks @seratch
• #1458 Add skip comments for any type warnings in socket-mode module - Thanks @seratch

See the full list of issues/pull requests of this release here.

See @slack/socket-mode@1.3.0 instead

See @slack/socket-mode@1.3.0-rc.1 instead

• Add missing parameters in chat.update API method (via #1433) - thanks @seratch!
• Upgrade the minimum axios version to the latest (web-api) (via #1447 ) - thanks @seratch!
• Fix #1452 fields[key].label is missing in users.profile.get responses (via #1453 ) - thanks @seratch @75asa!
• Auto code generation added Huddles / clip related properties to response types - thanks @seratch!

See the full list of issues/pull requests of this release here.

• Improve debug-level logging in InstallProvider#handleInstallPath() (via #1451) - thanks @seratch!

See the full list of issues/pull requests of this release here.

Changes

• Fix #1435: Proper use of state parameter for the OAuth CSRF protection (via #1436) - thanks @seratch!
• Fix #1439: Add built-in StateStore implementations using server-side database (via #1441) - thanks @seratch!
• Fix #1438: Add more callbacks (beforeRedirection, before/afterInstallation, async success/failure) in InstallProvider (via #1442) - thanks @seratch!
• Re-organize the source files in the OAuth package (via #1430) - thanks @seratch!
• Add error types to exposed ones from @slack/oauth (via #1431) - thanks @seratch!
• Update FileInstallationStore to behave more consistently (via #1437) - thanks @seratch!
• Fix eslint warnings and TODOs in OAuth module (via #1425) - thanks @seratch!
• Rename sub directory for installation stores (via #1443) - thanks @seratch!
• Add exported interface types that were missing in v2.5.0-rc1 release (via #1446) - thanks @seratch!

Document changes

• Fix docs callbackOptions.success param to be installOptions (via #1429) - thanks @mwbrooks!
• Adding documentation for handleInstallPath, beforeRedirection, beforeInstallation, afterInstallation (via #1448) - thanks @filmaj

See the full list of issues/pull requests of this release here.

• Fix docs callbackOptions.success param to be installOptions (via #1429) - thanks @mwbrooks!
• Re-organize the source files in the OAuth package (via #1430) - thanks @seratch!
• Fix eslint warnings and TODOs in OAuth module (via #1425) - thanks @seratch!
• Add error types to exposed ones from @slack/oauth (via #1431) - thanks @seratch!
• Update FileInstallationStore to behave more consistently (via #1437) - thanks @seratch!
• Fix #1439: Add built-in StateStore implementations using server-side database (via #1441) - thanks @seratch!
• Fix #1435: Proper use of state parameter for the OAuth CSRF protection (via #1436) - thanks @seratch!
• Fix #1438: Add more callbacks (beforeRedirection, before/afterInstallation, async success/failure) in InstallProvider (via #1442) - thanks @seratch!
• Rename sub directory for installation stores (via #1443) - thanks @seratch!

See the full list of issues/pull requests of this release here.

• Add accessibility_label to button type block element (via #1419) - thanks @seratch!
• Add admin.users.unsupportedVersions.export API support (via #1420) - thanks @seratch!
• Generate Web API response types including bookmarks.* (via #1423) - thanks @seratch!
• Include Retry-After raw response header value when throwing an error due to invalid Retry-After header (via #1426) - thanks @filmaj!
• Add bookmarks.* API methods (via #1427) - thanks @srajiang!

See the full list of issues/pull requests of this release here.

• Upgrade axios to 0.25 to address security vulnerabilities (via #1416) - thanks @seratch!
• Add support for the admin.apps.requests.cancel API method (via #1413) - thanks @seratch!
• Add the files and related properties and their types in conversations.replies API responses (via #1405 and #1403) - thanks @seratch!
• Fix #1397: some fields in conversations.list API responses were missing their types (via #1398) - thanks @seratch!
• Add the focus_on_load property to the views.* API responses (via #1386) - thanks @seratch!
• Tweaking the User-Agent field when communicating with Slack APIs in the deno runtime (via #1384) - thanks @filmaj!

See the full list of issues/pull requests of this release here.

• Fix #1378: Expose axios timeout parameter for webhooks (via #1394) - thanks @xuhas!
• Fix #1368: NPM Audit fix: https://github.com/advisories/GHSA-cph5-m8f7-6c5x - thanks @xmariopereira!

See the full list of issues/pull requests of this release here.

• Fix #1083: Add test to confirm clientOptions get passed to web-api (via #1359) - thanks @filmaj!
• #1360: Add explicit check for enterprise id - thanks @stophecom!
• Fix #1409: installerOptions.failure() options can be undefined (via #1410) - thanks @seratch!
• #1411: Refactor the internals of InstallProvider for better null safety - thanks @seratch!

See the full list of issues/pull requests of this release here.

• Adds support for apps.notifications.subscriptions.* API endpoints (Subscribe in Slack) -(#1401) thanks @srajiang

• Adds a new Metadata type (#1401) - thanks @srajiang!

• #1392, #1391 - Updates WorkflowStepView fields - thanks @srajiang @filmaj @bkeung!

• #1349 #1350 @slack/type View changes cause compile errors - Thanks @amphro @misscoded
• #1387 Add focus_on_load to the block element types - Thanks @seratch

See the full list of issues/pull requests of this release here.

• #1365 Add team.* APIs for rtm.start migration - Thanks @seratch!
• #1371 Add admin.users.session.resetBulk API support - Thanks @seratch!
• #1336 Fix #1326 Add admin.conversations.{get|set|remove}CustomRetention API - Thanks @seratch!
• #1373 Remove invalid arguments from oauth.v2.exchange API method - Thanks @seratch!
• #1351 Add pronouns to user.profile response data - Thanks @seratch!
• #1341 #1348 #1362 Add new properties to web-api responses - Thanks @seratch!
• #1337 #1132 web-api token should be passed in header instead of body param - Thanks @filmaj!
• #1334 Upgrade axios once nock issue is resolved - Thanks @filmaj!
• #1321 Fix #1302 Invalid JSON string causing “Cannot create property ‘response_metadata’ on string” error - Thanks @seratch @wizar!
• #1374 Disable typescript-eslint/no-explicit-any in internal code of web-api - Thanks @seratch!
• #1324 #1320 Fix #1318 Add notice comments to auto-generated source files - Thanks @seratch!

See the full list of issues/pull requests of this release here.

• #1317 Add more event data to event listener arguments - Thanks @seratch!
• #1322 #1251 CVE-2021-32640 - “ws” is vulnerable to ReDoS attacks - Thanks @seratch @simeon95!
• #1205 Add unit tests for @slack/socket-mode - Thanks @seratch!

See the full list of issues/pull requests of this release here.

New Features (Beta)

App Manifests

This release includes support for app manifests. The apps.manifest.* endpoints can be used to create, delete, update, and copy your Slack apps with ease. New endpoints include:

• apps.manifest.create
• apps.manifest.delete
• apps.manifest.export
• apps.manifest.update
• apps.manifest.validate
• tooling.tokens.rotate

Changes

Added support for App Manifest Endpoints (#1355) - Thanks, @misscoded!

• Adds an option to disable default state verification during OAuth flow - Thanks @srajiang and @seratch!
• Better error handling when users cancel installations (#1186, #1333) - Thanks @filmaj and @misscoded!

• Added Sign in With Slack (OpenID Connect) support (#1296, #1307) - Thanks @seratch
• Add Slack Connect APIs response types and tests (#1284, #1283, #1306) - Thanks, @srajiang and @seratch
• Adding “private” property in shares in files API responses (#1294, #1303) - Thanks, @seratch and @JeanBarriere.
• Added more info to rate limited error exception message (#1214, #1312) - Thanks @seratch
• Updated admin.users.invite endpoint (#1297, #1298) - Thanks @stevengill!

• Split View type for improved linting (#1276) - Thanks @alexjamesmalcolm!
• Split Option into PlainTextOption and MrkdwnOption (#1270, #1268) - Thanks, @rr-codes!

• Adds Message Metadata property to chatPostMessage + chatUpdate (#1309, #1308) - Thanks, @srajiang

• Add Slack Connect (conversations.*) and admin.auth.policy.* support (#1283, #1284) - Thanks, @srajiang!
• Updated Web API response types (#1285) - Thanks, @seratch!
• Added Node 16.x to the CI (#1249) - Thanks, @connorads!
• Fixed the PinsAddArguments and PinsRemoveArguments interfaces (#1277) - Thanks, @rr-codes!
• Added support for Axios timeout customization (#1264) - Thanks, @misscoded!

• Added support for token rotation (#1287) - Thanks, @misscoded!
• Added support for FileInstallationStore (#1279) - Thanks, @misscoded!
• Added support for deleteInstallation method off of InstallationStore (#1272) - Thanks, @misscoded!

#1226 Add type support for the time picker block element - Thanks, @raycharius! #1189 Fix misspelled words - Thanks, @seratch!

#1258 Update README + docs with deprecation notice - Thanks, @misscoded! #1194 Remove broken CI badges from READMEs - Thanks, @seratch!

#1258 Update README + docs with deprecation notice - Thanks, @misscoded! #1189 Fix misspelled words - Thanks, @seratch!

• #1187 Fix #1185 Add state metadata to Installation interface - Thanks @misscoded @seratch!
• #1206 Pass logger through to WebClient and fix broken logLevel warning - Thanks @sommd!
• #1208 Resolve inconsistent package dependencies across slack packages - Thanks @seratch!

See the full list of issues/pull requests of this release here.

• #1236 Fix #1235 ViewsOpenResponse type is incorrect - Thanks @rr-codes!
• #1242 Fix #1240 by enabling to pass integer as post_at in chat.scheduleMessage API calls - Thanks @Zummek!
• #1252 #1254 Changed type of created on UsersConversationsResponse - Thanks @swaters-atlassian!
• #1238 #1247 #1254 Update the web-api response types - Thanks @seratch!

See the full list of issues/pull requests of this release here.

• Update apps.connections.open API response type in SocketModeClient (#1234) - Thanks @seratch!
• Correct Socket Mode package README (#1193) - Thanks @slifty!

See the full list of issues/pull requests of this release here.

• Enable accessing all response types from @slack/web-api (#1232) - Thanks @seratch!
• Update Web API responses - Thanks @seratch!

See the full list of issues/pull requests of this release here.

• Fix invalid types introduced by #1209 (#1233) - Thanks @seratch!

See the full list of issues/pull requests of this release here.

• Add API response types to web-api methods (#1188 #1203 #1215) - Thanks @seratch!
• Add a few missing ones and types to WebClient arguments (#1209) - Thanks @seratch!
• Fix #1192 Add admin.users.session.* API support (#1198) - Thanks @seratch!
• Fix #1195 Make text arg optional in chat.* methods (#1197) - Thanks @seratch!
• Make text optional in chat.postMessage arguments and add warn logging if it’s missing (#1173) - Thanks @kentac55!
• Pass logger through to WebClient and fix broken logLevel warning (#1206) - Thanks @sommd!
• Fix required parameters in chat.update method (#1063) - Thanks @dginovker!
• Warn logging if thread_ts is not a string (#1223) - Thanks @hi1280!
• Added exclusion logic for Electron based apps to prevent changing User-Agent header (#1220) - Thanks @5tarlxrd!
• Resolve inconsistent package dependencies across slack packages (#1208) - Thanks @seratch!
• Add integration tests with real Slack servers (#1200) - Thanks @seratch!
• Add a unit test verifying #1037 is no longer an issue (#1204) - Thanks @seratch

See the full list of issues/pull requests of this release here.

• Add new user_auth_blocks property to chat.unfurl (#1174) - Thanks @pichsenmeister!

• Improved debug logging (https://github.com/slackapi/node-slack-sdk/pull/1175) - Thanks @seratch!

• Clear timer when input promise resolves before time runs out (#1180 #1181) - Thanks @oshchyhol!

• fixed socketMode error with incorrect appToken not being properly thrown (#1156, #1161) - thanks @stevengill, @g12i
• fixed passing in an agent to WebSocket in a proper way (#1162) - thanks @g12i

• fixed @slack/oauth failing when no bot scopes (only user scopes) are requested (#1158, #1163) - thanks @stevengill, @KhushrajRathod

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill
• Added apps.connections.open method (#1096) - thanks @stevengill

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill

• Released the new @slack/socket-mode package 🎉 ! This package is designed to support Socket Mode, which allows your app to receive events from Slack over a WebSocket connection. To learn more about Socket Mode, checkout the release blog post (#1096) - thanks @stevengill

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill
• Breaking: Removed fetchOrgInstallation and storeOrgInstallation methods from the InstallationStore. See our migration guide for more details on how to support org wide app installations. (#1133, #1148) - thanks @stevengill

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill

This package is now deprecated. Please consider migration over to Bolt for JavaScript. See our migration guide for more details.

• Updated minimum Nodejs version to 12.13.0, updated minimum TypeScript version to 4.1 (#1146, #1147) - thanks @stevengill

This package is now deprecated. Please consider migration over to Bolt for JavaScript. See our migration guide for more details.

• Updated axios dependency to fix security issue (#1140, #1141) - Thanks @mlarraz

• Updated axios dependency to fix security issue (#1142) - Thanks @stevengill
• Added auth.teams.list api method (#1137, #1139) - Thanks @stevengill, @daveagill
• Added support for admin.barriers.* methods (#1126, #1127) - Thanks @misscoded
• Migrated CI over to GitHub Actions (https://github.com/slackapi/node-slack-sdk/pull/1129) - Thanks @stevengill

• Updated axios dependency to fix security issue (#1144) - Thanks @stevengill

• added support for org wide app installations. This includes adding team_id as an optional argument to various web-api methods and adding team_id as an optional parameter to WebClientOptions so it will be automatically passed along to any web-api calls being made. (#1046) - Thanks @stevengill
• Update ViewsUpdateArguments to accommodate external_id and view_id (#1002, #1116) - thanks @misscoded
• Added admin.users.session.list method (#1111) - thanks @stevengill

• Added support for the upcoming org wide installation feature (#1046)! This new release introduces two new optional methods to the installationStore, fetchOrgInstallation and storeOrgInstallation. It is recommended adding these methods to your custom installationStores if you wish to support org wide installations. Checkout our docs to learn more!

Added the following API method:

• admin.conversations.archive
• admin.conversations.convertToPrivate
• admin.conversations.create
• admin.conversations.delete
• admin.conversations.disconnectShared
• admin.conversations.ekm.listOriginalConnectedChannelInfo
• admin.conversations.getConversationPrefs
• admin.conversations.getTeams
• admin.conversations.invite
• admin.conversations.rename
• admin.conversations.search
• admin.conversations.setConversationPrefs
• admin.conversations.unarchive
• admin.emoji.add
• admin.emoji.addAlias
• admin.emoji.list
• admin.emoji.remove
• admin.emoji.rename
• admin.users.session.invalidate
• apps.event.authorizations.list
• apps.uninstall

(#1093, #1098, #1099) - thanks @stevengill, @cjdenio & @mwbrooks

• Added dispatch_actionproperty to input blocks (#1102) - Thanks @stevengill
• Added dispatch_action_config property to PlainTextInput (#1108, #1109) - Thanks @stevengill

• added missing user_id to oauth v1 responses (#1103, #1105) - thanks @lasseschou and @stevengill

• Adds new Web API methods as part of the Workflow Steps from Apps functionality (#1094) - thanks @misscoded. NOTE: This feature is currently in open beta, and some details may change between now and when the beta is complete.
  • workflows.stepCompleted
  • workflows.stepFailed
  • workflows.updateStep

• Updates View to include the new possible value for the type property, workflow_step (#1094, #1076) - thanks @misscoded, @selfcontained
• Adds missing properties of View: submit_disabled and external_id. (#1094) - thanks @misscoded

This release includes a minor addition to the Workflow Steps from Apps beta. 🎉

• Added external_id to View interface (#1085) - Thanks, @misscoded!

• Added clientOptions and authorizationUrl as options that @slack/oauth accepts. clientOptions is passed along to @slack/web-api. authorizationUrl is used to override the authorization endpoint this library uses (default is https://slack.com/oauth/v2/authorize (#1055, #1081) - Thanks @stevengill

This release includes additions to the Workflow Steps from Apps beta. 🎉

Updated @slack/types dependency

This release includes additions to the Workflow Steps from Apps beta. 🎉

• Added methods (#1076) - Thanks, @selfcontained!
  • Add a type value for the new workflow_step view type

• Added header block support to types (#1066, #1068) - Thanks @ifvictr + @seratch!

• Added check that headers exist before calling verifySignature (#1069, #1070) - Thanks to first-time contributor @ramsgoli!

• Added new web-api methods (#1047, #1049, #1045 ) - Thanks, @kian2attari + @clavin!
  • admin.conversations.restrictAccess.addGroup
  • admin.conversations.restrictAccess.listGroups
  • admin.conversations.restrictAccess.removeGroup
  • conversations.mark
  • calls.participants.remove
  • admin.usergroups.addTeams
• Deprecated admin.conversations.whitelist.* methods (#1048, #1050) - Thanks, @kian2attari!
• Change paginate return type to AsyncIterable (#1040, #779) - Thanks, @clavin!
• Add error to Methods superclass (#1036, #1042) - Thanks, @clavin!
• Move method bindings from WebClient.ts to methods.ts (#1036) - Thanks, @clavin!

This release is for the Workflow Steps from Apps beta. 🎉

• Added methods (#1056) - Thanks, @misscoded!
  • workflows.stepCompleted
  • workflows.stepFailed
  • workflows.updateStep

• Added calls API support (#1021, #1026) - Thanks @stevengill

• Added calls API support (#1021, #1026) - Thanks @stevengill
• Added default_to_current_conversation field to conversations_select and multi_conversations_select (#1029, #1030) - Thanks @seratch
• Added style field to Confirm interface (#1022, #1023) - Thanks @seratch

• Updated types/ws dependency to fix failing tests (#1024, #1034) - Thanks @stevengill

• Add admin.usergroups.* APIs for Grid org admins (https://github.com/slackapi/node-slack-sdk/pull/1015) - Thanks @seratch

• Fixed enterprise field not being populated in installation object (https://github.com/slackapi/node-slack-sdk/pull/1020) - Thanks @stevengill
• Improved OAuth success user experience flow (https://github.com/slackapi/node-slack-sdk/pull/1011) - Thanks @stevengill
• Updated OAuth examples and copyright date (https://github.com/slackapi/node-slack-sdk/pull/1006) - Thanks @marks!

• Updated yargs dependency due to a security issue (https://github.com/slackapi/node-slack-sdk/pull/1008) - Thanks @shlasouski

• Added package prefix to logger name (#995, #999) - thanks @stevengill, @seratch
• Added warnings for deprecated methods (#992) - thanks @stevengill

• Support checkboxes block element in input block for TypeScript users. (#993, #994) - thanks @yoichiro
• Support radio_buttons block element in input block for TypeScript users (#979, #980) - thanks @seratch

• Added package prefix to logger name (#995, #999) - thanks @stevengill, @seratch

This is the first release of our new @slack/oauth package! Slack apps that are installed in multiple workspaces, like in the App Directory or in an Enterprise Grid, will need to implement OAuth and store information about each of those installations.

• Supports V2 OAuth for Slack Apps as well as V1 OAuth for Classic Slack apps.
• Includes a pluggable interface to easily hook in your own database to save and fetch installation data (like tokens).
• Handles state generation and state verification
• Has a method for creating “Add to Slack” buttons for direct installs
• Redirects back to the Slack app after the installation flow completes

Make sure to checkout the docs and our OAuth Express example app to learn more!

Issue: #950 PR: #963

Thanks @stevengill, @aoberoi, @seratch and @shaydewael!

• Added new .shortcut method to support global shortcuts (#984, #985) - thanks @stevengill
• Improved code sample in interactive-messages docs (#986, #987) - thanks @seratch

• Add filter objects on conversations_select and conversations_multi_select (#976) - thanks @shaydewael
• Add MrkdwnElement to text on Option - thanks @tteltrab

• Update security issue due to outdated axios dependency. (#955, #959) - Thanks @seratch

• Update security issue due to outdated axios dependency. (#955, #959) - Thanks @seratch
• Surface up error message from platform api calls (#946, #945) - Thanks @stevengill

• Added types for radio buttons and checkboxes (#964, #966) - Thanks @seratch

• Update security issue due to outdated axios dependency. (#955, #959) - Thanks @seratch
• Add types field to package.json (#919) - Thanks @G-Rath
• Fix viewSubmission callbackId constraint error (#910, #947) - Thanks @pichsenmeister

• Fix TypeScript build failure related to EventEmitter types (#951, #958) - Thanks @seratch
• Minor docs improvements (#956) - Thanks @mlnchk
• Add types field to package.json (#918) - Thanks @G-Rath

• Added new admin.* APIs (#942). Thanks @stevengill! These include:
  • admin.apps.approved.list
  • admin.apps.restricted.list
  • admin.conversations.setTeams
  • admin.teams.create
  • admin.teams.list
  • admin.teams.settings.info
  • admin.teams.settings.setDefaultChannels
  • admin.teams.settings.setDescription
  • admin.teams.settings.setDiscoverability
  • admin.teams.settings.setIcon
  • admin.teams.settings.setName
  • admin.users.list
  • admin.users.setExpiration
• Fixed Logger given to WebClient being destructively modified bug (#916). Thanks @seratch
• Minor docs readability improvements (#915). Thanks @TigerTopher

• added payload to debug when no handler matches (#928). Thanks @davidalpert!

• Fixed an error in a code sample in the documentation (#936) - Thanks @seratch!

• Added admin.inviteRequests.* APIs (#907). - thanks @seratch! These include:
  • admin.inviteRequests.approve
  • admin.inviteRequests.deny
  • admin.inviteRequests.list
  • admin.inviteRequests.approved.list
  • admin.inviteRequests.denied.list
• Added configuration in launch.json for vscode debugging of tests (#913) - thanks @stevengill

• Removed UserElement type as it is not available publicly. (#905/#912) - thanks @stevengill
• Make title optional and support home type for views. (#902) - thanks @ahayworth

• Adds oauth.v2.access method to WebClient to support v2 OAuth flow (#903) - thanks @seratch

• Adds the .viewSubmission() and .viewClosed() methods to the adapter to handle events from Modals (#904) - thanks @aoberoi

Adds Admin APIs v1 #897 - Thanks @seratch 🎉

• Adds the views.publish Web API method, and type definitions. (#894) - thanks @shanedewael

Re-add getLogger() to the logger interface - #887

Reverts getLevel() on logger interface because that’s a semver major change. Includes changes from #884 and #885

• Fixes the arguments for views.update (#877) - thanks @seratch

• Fixes the callback_id argument for views.open (#879) - thanks @PerStirpes

• Fixes HTTPError status code in error message. #850 (thanks @aoberoi)

• Adds support for Block Kit in Modals. #870 (thanks @shanedewael)
• Adds support for the Remote Files API. #839 (thanks @seratch and @aoberoi)
• Adds support for managing App approvals. #855 (thanks @aoberoi)
• Adds support for user session reset for Admins. #856 (thanks @aoberoi)
• Marks channels.list arguments exclude_archived and exclude_members optional. #865 (thanks @mottox2)

• Adds types for various multi-select blocks, for app views, and updates existing Block Kit types with confirm properties. #870 (thanks @shanedewael)

• Adds workaround for TypeScript 3.6 breaking change. #864 (thanks @aoberoi)

• Adds getLevel() method to the Logger interface, and the ConsoleLogger implementation #792 (thanks @seratch)

• Add support for pre-parsed requests (#800, #844) - thanks @troysteinbauer, @clavin.
  • Functionality was ported from @slack/events-api.
  • This enables serverless environments & other middleware to pre-parse a request’s body so long as they populate the rawBody field of the request.

• Add KnownBlock to incoming webhook argument (#807) - thanks @beeme1mr.
• Use destructuring import for IncomingWebhook (#782) - thanks @Nilhcem.
• Correcting documentation of https-proxy-agent usage (#811) - thanks @rajashekar.
• Bump webhook deps to fix security warnings (#812) - thanks @seratch.

• Add support for the Remote Files API (#839) - thanks @seratch & @aoberoi.
• Update form-data to 2.5.0, removes @types/form-data (#833) - thanks @copperwall.
• Add WebClient test cases for invalid Retry-After headers (#803) - thanks @copperwall.
• Bump web-api deps to fix security warnings (#812) - thanks @seratch.
• Add messages property under response_metadata (#832) - thanks @seratch.
• Add method name to apiCall debug (#835) - thanks @clavin.

• Add support for the Remote Files API (#839) - thanks @seratch & @aoberoi.
• Add ‘style’ to Button type (#797) - thanks @deremer.

• Convert @slack/interactive-messages to TypeScript (#799) - thanks @clavin.
  • This package is still meant to be used by JavaScript developers!
• Bump interactive-messages deps to fix security warnings (#812) - thanks @seratch.
• Fixes broken links to local development tutorial (#774) - thanks @aoberoi.
• Increase test timeout multipliers (#840) - thanks @clavin.

• Convert @slack/events-api to TypeScript (#799) - thanks @clavin.
  • This package is still meant to be used by JavaScript developers!
• Bump events-api deps to fix security warnings (#812) - thanks @seratch.
• Fixes broken links to local development tutorial (#774) - thanks @aoberoi.

• Fix incorrect homepage for legacy wrapper (#793) - thanks @felixrieseberg.

• Change eventemitter3 import for compatibility when TypeScript is configured without esModuleInterop (#760) - thanks @aoberoi

• Fixes a typo in the README that accidentally mentioned @slack/web-api (#768) - thanks @the6thm0nth.
• Change eventemitter3 import for compatibility when TypeScript is configured without esModuleInterop (#760) - thanks @aoberoi

• Adds a README to the package distribution (#776) - thanks @aoberoi.

This meta-release marks the beginning of a new organizational structure for the code related to each of Slack’s official Node.js packages.

Major version releases

The following packages have changes listed in their release notes:

• @slack/web-api@v5.0.0
• @slack/rtm-api@v5.0.0
• @slack/webhook@v5.0.0
• @slack/client@v5.0.0

See the migration guide for information about how to update your app from a previous version.

No new release

• @slack/events-api@v5.0.0: Moved from the original repository.
• @slack/interactive-messages@v5.0.0: Moved from the original repository.

New features

• Brand new, independent, and lighter weight package

Breaking changes

• Supports Node v8.9.0 and higher
• No longer supports a callback parameter for IncomingWebhook.send()
• agent option has been simplified
• Some ErrorCode constants have changed.

See the migration guide for details.

New features

• Brand new, independent, and lighter weight package
• WebClient.paginate() method: call cursor-paginated Web API methods using an async iterator 🎉

Breaking changes

• Supports Node v8.9.0 and higher
• No longer supports a callbacks for named Web API methods, or the WebClient.apiCall() method.
• The scopes, acceptedScopes, and retryAfter properties of a Web API call result have moved into the response_metadata.
• Removed previously deprecated methods
• Removed deprecated token rotation
• Renamed retry policies to more intuitive names
• agent option has been simplified
• Some ErrorCode constants have changed.
• Support Logger objects without a logger function.

See the migration guide for details.

New features

• Brand new, independent, and lighter weight package

Breaking changes

• Supports Node v8.9.0 and higher
• No longer supports a callbacks for named Web API methods, or the RTMClient.sendMessage() method.
• Removed the raw_message event in favor of the slack_event event.
• agent option has been simplified
• Some ErrorCode constants have changed.
• Support Logger objects without a logger function.

See the migration guide for details.

Fixes matching with actionId and blockId (#90)

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v1.1.1

• Adds Block Kit support (#85)
• Improves express all interactions by using body parser and removing verification check (#79 - thanks @ErwinLengkeek)

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v1.1.0

• Adds a timing safe comparison to guard from timing attacks. Thanks @episod billdybas (#71)

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v1.0.2

This release adds support for request signing, decouples the adapter from express, and fixes bugs:

• Adds support for the more secure request signing over legacy verification tokens. This change requires developers to now pass in a Signing Secret to the adapter rather than a verification token. (#57)
• Refactored the adapter to decouple express, which included adding parsing within the adapter, meaning developers no longer need to use middleware to parse the request (such as the body-parser package). (#31)
• A bug preventing message actions from working properly was fixed. (#56 - thanks @mcolyer 🎉)

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v1.0.0

This release adds support for new message actions. Your users can now interact with you app through dedicated actions per message.

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v0.4.0

• New Feature Support for dynamic menu options inside dialogs and the within constraint! #36
• Fixed bugs in dialog submission action support (#25) and menu options requests (#23) #28
• README has been rewritten with numerous clarifications and improvements (#27, #29) #39
• Example app express-all-interactions added #39
• Reference documentation added (#11) #39
• Test coverage exceeds 85% (#9)
• SlackMessageAdapter’s dispatch() method is now always async (#33)
• Added vscode workspace settings (#35)

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v0.3.0

• Added support for dialogs

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v0.2.0

Our first real distributable release! 🎉

The @slack/interactive-messages module makes it quick and simple for your app to respond to buttons and menus inside Slack. Find out all about the features in the README.

• Fixes an issue with regex-based action matching (#1) - thanks @hwz.

Original: https://github.com/slackapi/node-slack-interactive-messages/releases/tag/v0.1.2

• Supports Firebase Cloud Functions and other serverless cloud providers by inspecting req.rawBody when the body appears to already be parsed. thanks @pichsenmeister! (#90)

• Improves the example app greet-and-react. It can now persist tokens using node-localstorage, so that you don’t need to install the app each time its restarted (#84). Also, a bug in the arguments for chat.postMessage() was fixed (#83). thanks @ErwinLengkeek!

Original: https://github.com/slackapi/node-slack-events-api/releases/tag/v2.2.0

• Adds a timing safe comparison to guard from timing attacks. Thanks @episod billdybas (#77)

Original: https://github.com/slackapi/node-slack-events-api/releases/tag/v2.1.1

• Exports a new function verifyRequestSignature({ signingSecret, requestSignature, requestTimestamp, body }). This function can be used to verify the authenticity of a request even without using the requestListener or expressMiddleware offered by this package. It’s a useful utility when your application doesn’t need the adapter (EventEmitter), but you don’t want to reinvent the signature check. thanks @ianwsperber (#71)

Original: https://github.com/slackapi/node-slack-events-api/releases/tag/v2.1.0

This releases refactors a large portion of the adapter, adds support for request signing, and fixes a lot of bugs:

• The export name is changed from createSlackEventAdapter to createEventAdapter (#37)
• Adds request signing support, discontinuing support for verification tokens. This change requires developers to now pass in a Signing Secret in to the adapter rather than a verification token. (#57)
• Decouples the adapter from express, which included adding parsing within the adapter, meaning developers no longer need to use middleware to parse the request (using something like the body-parser package)
• Documentation improvements (#41, #42, #44, #45, #46)

Original: https://github.com/slackapi/node-slack-events-api/releases/tag/v2.0.0

This release addresses a number of bug fixes since the initial release.

• When using the waitForResponse adapter option, error events sometimes did not emit the respond() callback function (#18)
• Added a adapter.stop() method which is close the built-in HTTP server if one was started, and return a Promise which resolves after all connections have ended. (#27)
• Errors thrown inside a handler will now result in a success response to the request by default (can be overridden by using waitForResponse and passing an error to the respond() callback) (#21, #25)
• Debugging support using the DEBUG environment variable. (#19, #22)
• More tests and documentation (#23, #26)

Original: https://github.com/slackapi/node-slack-events-api/releases/tag/v1.0.1

This release is meant to help users migrate to the smaller, lighter, independent packages. If you’d just like to test the compatibility of your app with the latest breaking changes, you can simply update the from a previous version of this package to this version. If everything works, you’re ready to change your code to depend on the independent packages instead.

For each of the follow classes, these packages should be used directly.

See the migration guide for more details.

• Adds support for scheduled messages (#743)
• Changes p-cancelable version to ~1.0.0 to fix type errors (#743)

• Deprecates auto-pagination. (#721) - thanks @aoberoi
• Changes log level of failed requests from DEBUG to WARN. (#718) - thanks @aoberoi
• Fixes bug where http_proxy and https_proxy environment variables unexpectedly interact with WebClient and RTMClient configuration. (#672) - thanks @aoberoi
• Fixes tests for IncomingWebhook agent option. (#719) - thanks @aoberoi
• Updates dependencies. (#725) - thanks @aoberoi

• Adds deprecation warnings for usage of a logging function. Use a Logger object instead. (#703) - thanks @aoberoi

• Adds support for Block Kit (#688) - thanks @shanedewael
• Adds deprecation warnings for callback and refresh token use (#698) - thanks @aoberoi

New Features

• The IncomingWebhook constructor now has an agent option. It works exactly like the agent option from WebClient. It’s very useful for setting a proxy for requests using packages like https-proxy-agent or tunnel. Thanks @romanbalayan (#640)

Documentation improvements

• Fixes the TypeScript lib configuration instructions for versions 3.1 and above. Thanks @melisdogan (#650).

New Features

• You can now specify HTTP headers you’d like to include on all requests from WebClient. Just pass a headers option to the constructor. Thanks @ethan0920 (#629).

Bug fixes

• Fixes a bug when specifying the agent option on WebClient using an agent from https-proxy-agent. Thanks @aoberoi (#645).

Documentation improvements

• Fixes pagination sample code. Thanks @smaeda-ks (#641).

• Adds missing WebClient instance in the Getting Started guide. Thanks @jharrilim (#637).

• Adds documentation for using the package within a TypeScript project - see https://slackapi.github.io/node-slack-sdk/typescript. Thanks @aoberoi (#644).

• Clarifies usage of Web API methods with no required options using callbacks. Thanks @aoberoi (#631).

This version is a special pre-release that is specifically meant to address a security issue. See #621 for details

• Upgrades the https-proxy-agent dependency (thanks @mistydemeo) #621

New Features

• Adds support for short lived tokens and automatic token refresh (#617) - thanks @aoberoi and @shanedewael

New Features

• RTMClient.start() now returns a Promise that resolves with the data emitted with the authenticated event - thanks @clavin (#611)
• Adds the state property to the type definition of Dialog - thanks @DominikPalo (#619)

Bug Fixes

• Fixes an issue where RTMClient did not emit the "disconnected" event when it fails to connect - thanks @clavin (#610)

Other

• Replaces the got dependency with axios - thanks @aoberoi (#620)

New Features

• Workspace apps can now call methods on behalf of users for methods which require the X-Slack-User header. When calling one of these methods, specify the user ID in the new on_behalf_of option. - thanks @aoberoi (#609)
• The new rejectRateLimitedCalls option in the WebClient constructor allows you to customize how you’d like to handle rate limiting. If you set it to true, the WebClient will not attempt to retry an API call for you, and will instead return an error with a code property set to the value ErrorCode.RateLimitedError. - thanks @aoberoi (#599)
• Automatic pagination for cursor-based pagination enabled methods: It’s always recommended to perform pagination using the cursor and limit options directly, but if you don’t pass either when calling a method, the WebClient will automatically iterate through all the pages and returned a merged result. - thanks @aoberoi (#596)
• The WebClient will warn when calling deprecated methods (files.comments.add and files.comments.edit) - thanks @aoberoi (#604)

Bug fixes and more

• Fixes the crash when RTMClient#disconnect() was called from the connecting state - thanks @aoberoi (#603)
• Fixes an issue where uploading a file without a token fails in WebClient with an unrelated error - thanks @aoberoi (#587)
• Resolves an issue where your app requires a newer version of @types/node than this package specifies - thanks @aoberoi (#605)
• Fixes the Dialog.selected_options type definition - thanks @harveyr (#588)
• Adds information, fixes syntax issues, and corrects typos in the documentation - thanks @chris-peterson, @jd0920 (#584, #600, #601)
• Tests against node v10 in Travis - thanks @aoberoi (#606)

This version is a special pre-release that is specifically meant to address a security issue. See #547 for details

• Drops support for node < v4 and updates request dep to solve for CVE-2018-3728. (thanks @aoberoi) #590
• Removes deprecated facet users.setActive (thanks @DominikPalo) #464

• Fixes an issue where RTMClient would crash after its connection was interrupted because upon reconnection the connection monitoring code would improperly handle new messages as pongs. (#578) - thanks @aoberoi.

• Adds new permissions method named aliases to WebClient: apps.permissions.resources.list and apps.permissions.scopes.list (#568) - thanks @ggruiz
• Fixes an issue where an RTMClient instance throws errors while trying to reconnect after a connection interuption (#560) - thanks @aoberoi
• Fixes issue where rate-limit handling in WebClient was not triggering, and adds tests (#570, #573) - thanks @ggruiz
• Adds missing IncomingWebhookResult type to exports (#562) - thanks @mledom
• Changes options argument of RTMClient#start() to be optional as it was intended (#567) - thanks @christophehurpeau

• Adds the notify_on_cancel field to the Dialog type definition (#541) - thanks @DominikPalo
• Adds AttachmentAction type definition to express the type of the action property of MessageAttachment. (#543, #551) - thanks @brianeletype, @DominikPalo
• Adds the SelectOption type defintion and related properties to the Dialog type definition. (#549) - thanks @DominikPalo
• Fixes the missing scopes property in WebClient responses. (#554) - thanks @aoberoi
• Fixes an issue in RTMClient where websocket errors in the connecting:authenticated state would cause the program to crash. (#555) thanks @aoberoi
• Fixes an issue where KeepAlive would monitor the RTM connection while the websocket was not ready after a reconnection. (#555) thanks @aoberoi
• Uses the "files" key in package.json to implement a whitelist of files that are packed for npm publish.

• Allows mrkdwn_in and callback_id fields in message attachments for formatting on attachment fields (#528) - thanks @DominikPalo
• Fixes optionality of validate argument for channels.join method (#530) - thanks @DominikPalo
• Adds the users.conversations method (#532) - thanks @DominikPalo
• Fixes overwriting of default parameters after send() call (#535) - thanks @franckbrignoli
• Fixes and adds logging for unexpected websocket close in StateMachine (#537) - thanks @shanedewael

• IncomingWebhook.send() works with both callbacks and Promises (#508) - thanks @clavin
• Completes type defintions for all WebClient method arguments (#512) - thanks @clavin
• Allows files.upload to work with Buffers (in addition to ReadableStreams) (#500) - thanks @KharitonOff
• Allows any WebClient methods argument to work with binary types (#519) - thanks @clavin and @aoberoi
• Fails when WebClient.apiCall() options don’t look like the right type (#522) - thanks @aoberoi
• Fixes TypeScript compile errors in node >=6 <=8 related to callbackify (#518) - thanks @aoberoi
• Fixes mismatched parenthesis in RTMClient usage example documentation (#511) - thanks @parthsr
• Adds examples directory back to the repository (#520) - thanks @aoberoi

• Fixes crash in projects where "name" or "version" were not defined in the package.json file (#478) - thanks @wilhelmklopp @clavin @aoberoi
• Fixes IncomingWebhook.send() to parse the response as text instead of JSON (#477) - thanks @aoberoi
• Allows IncomingWebhook to be initialized without defaults (#479) - thanks @aoberoi
• Allows WebClient to be initialized without a token in TypeScript (#482) - thanks @aoberoi
• Allows unspecificed arguments to be used with WebClient method aliases and apiCall() (#484) - thanks @clavin
• Exports method argument types as top level exports in the type declarations (#483) - thanks @aoberoi
• Fixes inaccurate property type for as_user in ChatPostMessageArguments (#475) - thanks @harveyr
• Improves the OAuthAccessArguments and OAuthTokenArguments types (#481) - thanks @aoberoi

Breaking Changes If you are upgrading from a previous version, follow our comprehensive Migration Guide to learn how to transport your app into the new, shiny, future!

WebClient

• New apiCall(method, options) public API for making generic Web API calls.
• Improved logging
• Improved error management
• Configuration for custom http Agent
• Custom TLS configuration
• Tons of performance improvements

RTMClient

• Improved message queuing - No need to wait for client to connect before sending a message.
• Lifecycle events driven by an all-new state machine
• New keep-alive algorithm
• Improved logging
• Improved error management
• Configuration for custom http Agent
• Custom TLS configuration
• Tons of performance improvements

General

• TypeScript declarations available for all APIs
• Updates all dependencies to their latest version
• Drops support for node versions less than 6.0

• Adds several missing RTM events into RTM.EVENTS export (thanks @clavin) #457 #448
• Adds users.lookupByEmail to WebClient (thanks @DominikPalo) #434
• Fixes stale values kept across requests when using requestOptionsTransport (thanks @bertrandom) #450
• Adds documentation for presence subscription over RTM (thanks @aoberoi) #454
• Fixes typos in documentation (thanks @konklone, @marclemagne, @aoberoi) #444, #446, #461, #466

As always, just run npm install @slack/client to get the latest version. Stay tuned for v4, coming soon!

Deprecates data store APIs See the migration document for more details: https://github.com/slackapi/node-slack-sdk/wiki/DataStore-v3.x-Migration-Guide

• Major docs content rewrite (thanks @aoberoi) #428, #239, #305, #310, #364, #366, #413, #411, #423
• Adds chat.getPermalink Web API method (thanks @DominikPalo) #431
• Adds opts.user argument to users.identity Web API method (thanks @bertrandom) #432
• Fixes bug with not passing optional arguments for conversations.info (thanks @aoberoi) #441
• Fixes dead link to node-retry (thanks @pine) #433
• Adds eaiser support for Buffer input in files.upload Web API method (thanks @aoeberoi) #307
• Refactors logger usage across the package (thanks @aoberoi) #334
• General JSDoc, require(), dead code, clean up

Adds a new transport that lets you define options on the request module, expose it from the library

Adds support for Dialogs

• Adds support for the conversations.* family of Web API methods. See https://api.slack.com/docs/conversations-api. - thanks @aoberoi
• Adds locale awareness options to various Web API methods. - thanks @aoberoi
• Fixes an argument encoding issue with calling users.profile.set (#360) - thanks @aoberoi
• Removes an inaccurate comment (#394) - thanks @AriLFrankel

• Adds MPIM data to the DataStore as Groups (#389) - thanks @aoberoi and @bradslavin

• Added chat.postEphemeral Web API endpoint to the WebClient (#384) - thanks @shanedewael
• Added linkNames option to IncomingWebhook (#342) - thanks @mozamimy
• Ignored package-lock.json for use with npm 5 (#385) - thanks @aoberoi

• RTM client can now be initialized to use rtm.connect instead of rtm.start with option useConnect: true (#344) - thanks @CharlieHess
• Adds the new Web API method: rtm.connect (#344) - thanks @CharlieHess
• Adds support for the chat.unfurl option userAuthRequired (#336) - thanks @againer
• Adds the new Web API method: im.replies (#339) - thanks @moinism
• Adds support for presence subscriptions (#350) - thanks @CharlieHess
• Improve reliability of RTM reconnects (#349) - thanks @CharlieHess
• Fixes issue with RTM reconnect not using the same options as the initial connect (#347) - thanks @CharlieHess
• Fixes out of order messages in client’s request queue (#346) - thanks @chapmanc
• Fixes bug in MemoryDataStore when seaching for a user by username that does not exist in the team (#332) - thanks @frejos
• Fixes example code to work as described in the comments (#337) - thanks @lukeb-uk

Adds the new Web API method: chat.unfurl. Check out App Unfurls!

• Well, that didn’t go so well, now did it? This release fixes #303

• In the past, you had to contort your callbacks to any Web API endpoint, because not all errors were propogated through the error parameter. Well, good news: We are no longer forcing you to sit uncomfortably. Server errors that result in a 200 OK + {ok: false, error:"mumble_mumble"} result are now passed through the error parameter so you can simplify your callback logic. If you want.
• Did you know that Slack will pass information on the scopes required to call a particular Web API endpoint? We do! And now you can get your hands on that very same information in your Web API callbacks too. Will help you debug and identify failed calls due to scoping issues.
• The Web API functionality has been expanded to include users.profile.[get|set]. Mind that you can only update your own profile
• Did you notice that there were errors in the documentation? There were (and almost certainly still are). Several concerned readers wrote in with comments and fixes, all of which have been addressed.
• Last but not least, we have added functionality to track basic usage of this SDK. All calls to the Web API and the RTM API are made with a user agent string that identifies the version of this SDK in use, as well as system information on node version and operating system. More better, you can add to this treasure trove of analytics—we’ve added a function in helpers.js that you can call from your code to let us know more about your framework or bot. In the future, we will be adding this same information to a wide range of SDKs that access the Slack Platform, and releasing usage data publicly so we can all see who is winning this popularity contest.

• Don’t know a user’s ID? Want to find a DM with that user anyway? Now you can retrieve a DM from the memory store by username. Awesome.
• API endpoints of the form a.b.c required a bit of rather tortured code to call. We have removed the torture requirements, and you can now call them as you might expect.

• You can now use arbitrary images for your bot’s avatar with incoming webhooks. Because your app wasn’t creepy enough before.
• Previously, we had no support for HTTPS proxies. This unfortunate situation has been rectified, and now your bot can live behind the nastiest sorts of firewalls.

• Adds support for Incoming Webhooks
• Fixes a bug around User IDs

• Fixes a bug whereby events with fields not recognized cause a crash. Wow.
• Updated some logic around what user ids look like.

• Fixes a bug in the package.json published by 3.5.2.

• Updating the links in package.json so that you don’t need SSL credentials to pull down the github repo.

• Updates lodash from ^3.10.1 to ^4.13.1. And means it.
• Minor tweaks to existing documentation and example code to make them consistent with each other. Because hobgoblins are friendly and love you.

• Adds the team.billableInfo endpoint to the team facet
• Adds the bots.info endpoint and creates the bots facet
• Removes the user optional argument from the stars.list method

• Adds the chat.meMessage endpoint to the chat facet

• Creates a memory data store by default if an undefined, but not false

  null value is passed for opts.dataStore

• Aliases the retry policies to be human readable

• Updates the RTM client to emit an UNABLE_TO_RTM_START event when all reconnection attempts are exhausted, rather than throwing an error
• Suppresses some spurious log lines when tests are run

• Updates the _makeAPICall method to make the optional API args param optional to pass in, so the third param to this function can be either an opts object or a cb. This is to allow us to add optional arguments to API methods without it being a breaking change.
• Fixes the retry-after header name and adds a numeric fallback if the retry-after value can’t be parsed, thanks @foiseworth!
• Adds new API methods to various facets
  • auth.revoke
  • users.identify
• Adds optional arguments to:
  • files.comments.add: adds a channel param, for the channel id of the location to associate with the new comment
  • chat.delete: adds a boolean as_user param, to support deleting a message as the authed user

• Removes the DM facet
• Updates the aliasing approach for IM / DM to correctly alias DM to the IM Facet

• Updates the lib/clients/web/facets/index.js to reference the new facets added in the 3.0.0 update, thanks @ekmartin
• Adds in a reminders client facet
• MemoryDataStore.getUserByEmail now looks at the correct part of the user object for the email, thanks @SimantovYousoufov
• Adds docs and examples for the data store and sending DMs, thanks @PaulAsjes!

• Adds a number of new web client API facets:
  • dnd
  • files.comments
  • mpim
  • usergroups
  • usergroups.users
• BREAKING Changes the function signatures for some facet methods:
  • channels.list: exclude_archived moves to an opts object, instead of being a separate argument
  • groups.list: exclude_archived moves to an opts object, instead of being a separate argument
  • chat.delete: The ts and channel arguments are re-ordered to be alphabetical
  • stars.list: user moves to an opts object, instead of being a separate argument
  • users.list: presence moves to an opts object, instead of being a separate argument
• BREAKING Updates the function signature for BaseAPIClient.prototype.makeAPICall to take required API args and optional API args as separate params, from makeAPICall(endpoint, optData, optCb) to makeAPICall(endpoint, apiArgs, apiOptArgs, optCb)
• New methods are added to various facets:
  • files.revokePublicURL
  • files.sharedPublicURL
  • team.integrationLogs
  • team.integrationLogs

• Caches messages on the RTM client, to improve handling in cases where message send fails
• Removes the handler for the websocket level ping handler (not the RTM API level ping handler)
• Refactors the logic for handling ws send responses to a single function

• Adds an im alias for the dm facet to the web client, to match the API endpoint naming

• Adds promise support to the RTM client send and sendMessage methods
• Fixes the way message response callbacks work, so that the success case is only called when the websocket receives a message with a reply_to matching the id of the dispatched message, instead of when the ws instance signals message send success
• Fixes the way getAPICallArgs works, to correctly pull data out of the opts arg

• Fixes a crash introduce in 2.0.5 if you try and instantiate a WebClient without passing in any options

• Updates the way that API requests are throttled to:
  • avoid a condition where the request queue callback could be called multiple times, causing a crash
  • refactor the logic in _callTransport into multiple functions to make it easier to follow
• Updates dev dependencies:
  • eslint
  • nock
  • eslint-config-airbnb

NOTE: This release contained a bad bag that would cause a crash if you created a WebClient without passing in any options. It’s been unpublished from NPM and should not be used from here. Please use the 2.0.6 release instead.

• Passes through the logLevel param to the getLogger function

• The RTM AUTHENTICATED event now also emits the rtm.start payload
• Fixes the way that loggers are instantiated and used, so that the JSDoc for opts.logger is correct

• Adds coveralls to the repo, to track code coverage and display a badge in the README
• Updates the disconnect function on the RTM client to support both an error message and a code or reason for the disconnect, e.g. account_inactive
• Updates the message-handlers for team_xxx events to set the team back to the data-store once changes are made

• Updates to ws@1.0.1
• Fixes a bad variable name in example-web-client

Refactors the library to javascript, adds a lot of tests and restructures it to improve maintainability and extend functionality.

• Creates two separate clients:
  • RTM; manages connection to Slack’s RTM API, including reconnects
  • Web; provideas a callback interface to all of Slack’s Web API endpoints
• Moves the memory data store implementation off the clients and into its own class
• Uncouples the model objects from the clients; model functions to send messages to channels etc are now accessed via the web and RTM client
• Moves the transport layer (websockets and HTTP) to a pluggable model, so that complex transports (through request proxies etc) can be handled
• Adds test coverage on most core functionality in the library