Skip to main content

Changelog

v3.0.0 (2020-11-09)​

This is the first stable version of slack_sdk v3. The remarkable updates in this major version are:

  • Newly added OAuth flow support
  • Better Async/sync separation for WebClient and WebhookClient
  • Renamed packages (from slack to slack_sdk) with deprecation warnings

Refer to v3.0.0 milestone and the website for details. If you're a slackclient user, the migration guide for slackclient v2.x users is available at https://tools.slack.dev/python-slack-sdk/v3-migration/

v2.9.3 (2020-10-20)​

Refer to v2.9.3 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [Block Kit] #851 #852 Set default_type for HeaderBlock text - Thanks @fwump38
  2. [Block Kit] #853 #854 Enable to use input blocks in Home tab views - Thanks @fwump38
  3. [RTMClient] #857 #846 RTMClient does not pass timeout value to WebClient - Thanks @Luden @seratch

v2.9.2 (2020-10-09)​

Refer to v2.9.2 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [Block Kit] #841 Dispatch Action in Input blocks - Thanks @seratch
  2. [WebClient] #838 Add apps.event.authorizations.list and other APIs - Thanks @seratch
  3. [WebClient][WebhookClient] #829 Improve error body parser to handle no charset responses - Thanks @adamchainz @seratch
  4. [Block Kit] #824 Correct text field validation in Header blocks - Thanks @seratch

v2.9.1 (2020-09-23)​

Refer to v2.9.1 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [WebClient][WebhookClient] #820 #821 #822 The proxy option in WebClient/WebhookClient no longer works - Thanks @seratch

v2.9.0 (2020-09-17)​

Refer to v2.9.0 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [WebClient] #811 Add workflows.* API support - Thanks @misscoded
  2. [WebClient] #810 #809 Only set default filename in files_upload if file is an instance of str - Thanks @csaska

v2.8.2 (2020-09-04)​

Refer to v2.8.2 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [WebClient] #795 #794 Add admin.conversations.* API methods in WebClient/AsyncWebClient - Thanks @ruberVulpes
  2. [WebClient] #796 Fix a link to the Static options documentation - Thanks @Jamim

v2.8.1 (2020-08-28)​

Refer to v2.8.1 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [WebClient] #778 #779 Adding support for View objects for views.push/update/publish - Thanks @ruberVulpes
  2. [WebClient] #786 Fix admin.conversations.restrictAccess.* methods to match documentation - Thanks @ruberVulpes

v2.8.0 (2020-08-06)​

Refer to v2.8.0 milestone to know the complete list of the issues resolved by this release.

New Features

  1. [WebClient] #765 #766 Introduce AsyncWebClient/AsyncWebhookClient providing coroutines - Thanks @seratch
  2. [Block Kit] #767 #768 Add "header" block support - Thanks @mwbrooks

Updates

  1. [WebClient] #738 Add HTTP_PROXY, HTTPS_PROXY env variable support in async WebClient - Thanks @iamtofr @seratch
  2. [WebClient] #769 #773 Enable User-Agent to have additional info part - Thanks @seratch
  3. [WebClient] #770 #771 Fix a bug where files.upload's file param doesn't accept bytes data - Thanks @seratch

v2.7.3 (2020-07-20)​

Refer to v2.7.3 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [WebClient] #754 Fix #729 Add admin.conversations.restrictAccess.*, conversations.mark API - Thanks @ruberVulpes @kian2attari
  2. [WebClient] #758 Fix #757 Add admin.usergroups.addTeams, calls.participants.remove API - Thanks @seratch
  3. [WebClient] #727 Fix #645 Unclosed client session - Thanks @NoAnyLove @jourdanrodrigues
  4. [WebClient] #745 Fix #744 a validation logic bug in DatePickerElement - Thanks @dzudi941
  5. [WebClient] #752 Fix #733 Better error handling when getting TimeoutError in RTMClient#start() - Thanks @liorblob @seratch
  6. [WebClient] #751 Fix #718 by handling unexpected response body format - Thanks @jeffbuswell @seratch

v2.7.2 (2020-06-23)​

Refer to v2.7.2 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [WebClient] Fix #728 by adding bytearray support in files_upload (sync mode) - Thanks @sofya-salmanova @seratch
  2. [WebClient] #726 Fix InputBlock.hint validation failure - Thanks @jourdanrodrigues
  3. [WebClient] #723 Correct the default value of InputBlock.label, hint - Thanks @jourdanrodrigues

v2.7.1 (2020-06-04)​

This release includes the fixes for regression bugs in WebClient since v2.6.0. Refer to v2.7.1 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [WebClient] #716 #712 Support timeout in sync sync web clients - Thanks @DanialErfanian @seratch
  2. [WebClient] #713 Support custom SSL context in sync sync web clients - Thanks @austinbutler
  3. [WebClient] #715 #714 Support proxy in sync sync web clients - Thanks @austinbutler @seratch

v2.7.0 (2020-06-02)​

Refer to v2.7.0 milestone to know the complete list of the issues resolved by this release.

New Features

  1. [WebhookClient] #707 #270 #531 Add WebhookClient for Incoming Webhooks & response_url - Thanks @seratch @chubz @Ambro17

Updates

  1. [WebClient] #704 #695 Add calls\_\* methods to WebClient and CallBlock in Block Kit classes - Thanks @seratch
  2. [WebClient] #710 #536 Allow Tokens to be specified per request - Thanks @seratch
  3. [WebClient] #709 #708 Add default_to_current_conversation in conversations_select elements - Thanks @seratch

v2.6.2 (2020-05-28)​

Refer to v2.6.2 milestone to know the complete details of this release.

Updates

  1. [WebClient] #705 WebClient's paginated API calls may fail with no params - Thanks @seratch

v2.6.1 (2020-05-24)​

This patch release is a quick fix for #701, a major issue that affected RTMClient users in v2.6.0. The malfunction was introduced by #667 trying to address #558 #619. Those issues were reopened and will be resolved by another approach. Refer to v2.6.1 milestone to know the complete list of the issues resolved by this release.

Updates

  1. [RTMClient] #701 RTMClient drops some messages when they come in rapid succession - Thanks @pbrackin @seratch

v2.6.0 (2020-05-21)​

Refer to v2.6.0 milestone to know the complete list of the issues resolved by this release.

New Features

  1. [Block Kit] #659 Add complete supports for Block Kit components and fixed a few existing bugs as well (#500 #519 #623 #632 #635 #639 #676 #699) - Thanks @seratch @diurnalist @ruberVulpes @jeremyschulman @e271828- @RodneyU215
  2. [Signature] #686 Add slack.signature.SignatureVerifier for request verification - Thanks @seratch
  3. [WebClient] #682 Add missing Grid admin APIs (admin.usergroups.\*, admin.users.\*, admin.apps.\*) - Thanks @stevengill @seratch

Updates

  1. [WebClient][RTMClient] Fixed a bunch of the currency issues this SDK had (#429 #463 #492 #497 #530 #569 #605 #613 #626 #630 #631 #633 #669) - Thanks @seratch @aaguilartablada @aoberoi @stevengill @marshallino16
  2. [WebClient] #681 #560 Enable using bool values for request parameters - Thanks @roman-kachanovsky @seratch
  3. [WebClient] #661 #678 Improve handling of required "ids" parameters (e.g., channel_ids, users) - Thanks @seratch
  4. [WebClient] #680 Add non-conversation API deprecation warnings - Thanks @seratch
  5. [WebClient] #671 #670 Enable passing None values for request parameters (they used to result in errors) - Thanks @yuji38kwmt @seratch
  6. [WebClient] #673 Fix #672 files.upload fails with a filepath containing multi byte chars - Thanks @yuji38kwmt @seratch
  7. [WebClient] #656 Fix #594 preview_image for files.remote.add API method is not properly supported - Thanks @Eothred @seratch
  8. [Maintenance] #618 Add py.typed file to package distribution - Thanks @JKillian
  9. [WebClient] #599 Strip token string parameters of whitespace - Thanks @TheFrozenFire
  10. [WebClient] #692 Fix superfluous_charset warnings since v2.4.0 - Thanks @seratch
  11. [WebClient] #652 Update oauth_v2_access to include redirect_uri (as optional) - Thanks @tomasreimers

v2.5.0 (2019-12-09)​

New Features

  1. [WebClient] Adding new oauth.v2.access Web API method. #577

v2.4.0 (2019-11-27)​

New Features

  1. [WebClient] Adding new admin.* Web API methods. #571

Updates 1. [WebClient] We're no longer validating token types for Web API methods. Improves compatibility with granular bot permissions. #568 (Thanks @Smotko) 2. [WebClient] Correcting typos in descriptions #554 (Thanks @phamk) 3. [WebClient] Fixed 'iteracting' typo in library file headers #564 (Thanks @acabey) 4. [Message Builders] Remove value from LinkButtonElement #563 (Thanks @pedroma)

v2.3.1 (2019-10-29)​

Updates

  1. [WebClient] Fixing a regression that causes the client to close sessions prematurely. #544 (Thanks @fatih-acar!)
  2. [WebClient] Adding required missing view param to views.update Web API method. #542

v2.3.0 (2019-10-22)​

New Features

  1. [WebClient] Adding new views.publish Web API method. #540

Updates

  1. [WebClient] Some server responses don't return json. Correcting initial assumption. #540
  2. [Maintenance] Add py.typed to mark the library to support type hinting #524s

v2.2.1 (2019-10-08)​

Updates

  1. [Docs] Fix Indentation of Code Snippets in README.md #525 (Thanks @abhishekjiitr)
  2. [WebClient] Fix Web Client custom iterator #521 (Thanks @smaeda-ks)
  3. [WebClient] Oauth previously failed to pass along credentials properly. This is fixed now. #527
  4. [WebClient] When a SlackApiError occurs we're now passing the entire SlackResponse into the exception. #527

v2.2.0 (2019-09-25)​

New Features

  1. [WebClient] Adding new admin and remote files API methods. #501
  2. [WebClient] Adding new view API methods. #517

Updates

  1. [Message Builders] Update BlockAttachment to not send invalid JSON due to fields attribute #473 (Thanks @paul-griffith)
  2. [Docs] Add RTM section for docs v2 #477 (Thanks @shanedewael)
  3. [Docs] Fix typo; recieved -> received #478 (Thanks @joakimnordling)
  4. [Docs] Fix block kit link & update docs #484 (Thanks @clavin)
  5. [RTMClient] Return callback from RTMClient.run_on #490 (Thanks @clavin)
  6. [Docs] Fix link to Auth Guide in readme #498 (Thanks @asherf)
  7. [Docs] Fix missing word and typo #512 (Thanks @marks)
  8. [Message Builders] bugfix for value length in button elements #514 (Thanks @avanderm)
  9. [Docs] Fixes formatting #515 (Thanks @vpetersson)
  10. [Docs] Improve a code snippet on README #516 (Thanks @seratch)
  11. [WebClient] Fixed an OAuth Headers bug and made the token param optional. #517

v2.1.0 (2019-07-01)​

New Features

  1. Type-hinted helper classes for building messages in v2 #400 (Thanks @paul-griffith)

Breaking Changes

  1. [RTMClient] Converted the RTMClient#typing() function to async #446

Updates

  1. [RTMClient] Handle case in which aiohttp closes the websocket due to lack of ping responses. #453 (Thanks @flyte)
  2. Modify package identifier in user agent to match v1.x identifier #418 (Thanks @aoberoi)
  3. [WebClient] Fixed typo in Scheduled message #428 & #435 (Thanks @splinterific)
  4. Transform install_requires of 'aiodns' into extras_require. #440 (Thanks @staticdev)

Thank you!! To everyone who's opened, commented or reacted to an issue; this project is better because of you! Thank you for helping the Slack community!

v2.0.0 (2019-04-29)​

Original RFC

v2 PR

New Features

  1. Client Decomposition: We've split the client into two.

a. WebClient: A HTTP client focused on Slack's Web API. b. RTMClient: A websocket client focused on Slack's RTM API.

  1. RTMClient: Completely redesigned, this client allows you to link your application's callbacks to corresponding Slack events.
  2. WebClient: The WebClient now provides built-in methods for Slack's Web API. These methods act as helpers enabling you to focus less on how the request is constructed. Here are a few things that this provides:

a. Basic information about each method through the docstring. b. Easy File Uploads: You can now pass in the location of a file and the library will handle opening and retrieving the file object to be transmitted. c. Token type validation: This gives you better error messaging when you're attempting to consume an api method that your token doesn't have access to. d. Constructs requests using Slack's preferred HTTP methods and content-types.

Breaking Changes: If you're migrating from v1.x of slackclient to v2.x, Please follow our migration guide to ensure your app continues working after updating.

Check out the Migration Guide here!

Thank you! This release would not have been possible without the support of our community. Thank you to everyone who's contributed to this release.

v1.3.1 (2019-02-28)​

  • Lock websocket-client version to < 0.55.0: temp fix for #385

v1.3.0 (2018-09-11)​

## New Features - Adds support for short lived tokens and automatic token refresh #347 (Thanks @roach!)

## Other - update RTM rate limiting comment and error message #308 (Thanks @benoitlavigne!) - Use logging instead of traceback #309 (Thanks @harlowja!) - Remove Python 3.3 from test environments #346 (Thanks @roach!) - Enforced linting when using VSCode. #347 (Thanks @roach!)

v1.2.1 (2018-03-26)​

  • Added rate limit handling for rtm connections (thanks @jayalane!)

v1.2.0 (2018-03-20)​

  • You can now tell the RTM client to automatically reconnect by passing auto_reconnect=True

v1.1.3 (2018-03-01)​

  • Fixed another API param encoding bug. It encodes things properly now.

v1.1.2 (2018-01-31)​

  • Fixed an encoding issue which was encoding some Web API params incorrectly (sorry)

v1.1.1 (2018-01-30)​

  • Adds HTTP response headers to api_call responses to expose things like rate limit info
  • Moves token into auth header rather than request params

v1.1.0 (2017-11-21)​

  • Aadds new SlackClientError and ResponseParseError types to describe errors - thanks @aoberoi!
  • Fix Build Error (#245) - thanks @stasfilin!
  • include email as user property (#173) - thanks @acaire!
  • Add http reply into slack login and slack connection error (#216) - thanks @harlowja!
  • Removed unused exception class (#233)
  • Fix rtm_send_message bug (#225) - thanks @kt5356!
  • Allow use of custom parameters on rtm_connect() (#210) - thanks @kamushadenes!
  • Fix link to rtm.connect docs (#223) - @sampart!

v1.0.9 (2017-08-31)​

  • Fixed rtm_send_message ID bug introduced in 1.0.8

v1.0.8 (2017-08-31)​

  • Added rtm.connect support

v1.0.7 (2017-08-02)​

  • Fixes an issue where connecting over RTM to large teams may result in "Websocket URL expired" errors
  • A load of packaging improvements

v1.0.6 (2017-06-12)​

  • Added proxy support (thanks @timfeirg!)
  • Tidied up docs (thanks @schlueter!)
  • Added tox settings for Python 3 testing (thanks @cclauss!)

v1.0.5 (2017-01-23)​

  • Allow RTM Channel.send_message to reply to a thread
  • Index users by ID instead of Name (non-breaking change)
  • Added timeout to api calls.
  • Fixed a typo about token access in auth.rst, thanks @kelvintaywl!
  • Added Message Threads to the docs

v1.0.4 (2016-12-15)​

  • fixed the ability to search for a user by ID

v1.0.3 (2016-12-13)​

  • fixed an issue causing RTM connections to fail for large teams

v1.0.2 (2016-09-22)​

  • removed unused ping counter
  • fixed contributor guidelines links
  • updated documentation
  • Fix bug preventing API calls requiring a file ID
  • Removes files from api_calls before JSON encoding, so the request is properly formatted

v1.0.1 (2016-03-25)​

  • fix for __eq__ comparison in channels using '#' in channel name
  • added copyright info to the LICENSE file

v1.0.0 (2016-02-28)​

  • the api_call function now returns a decoded JSON object, rather than a JSON encoded string
  • some api_call calls now call actions on the parent server object:
    • im.open
    • mpim.open, groups.create, groups.createChild
    • channels.create, channels.join

v0.18.0 (2016-02-21)​

  • Moves to use semver for versioning
  • Adds support for private groups and MPDMs
  • Switches to use requests instead of urllib
  • Gets Travis CI integration working
  • Fixes some formatting issues so the code will work for python 2.6
  • Cleans up some unused imports, some PEP-8 fixes and a couple bad default args fixes

v0.17.0 (2016-02-15)​