slackapi/python-slack-sdk v3.1.0

version 3.1.0

on GitHub

New Features

Org-Wide App Installation support

This version includes the changes related to Org-Wide App feature, which is for Enterprise Grid organizations.

https://api.slack.com/enterprise/apps

• Add a few fields in installation data models (see the following migration guide for details)
• Switch to use InstallationStore#find_installation from InstallationStore#find_bot in authorize functions
• Enable Bolt apps to handle new events - team_access_granted / team_access_removed
• Add is_enterprise_install: bool in context object

Data Model Migration guide

If you're already using a built-in InstallationStore implementation, the following fields in the data row will be expected since v3.1. If your app uses relational database tables, please add the corresponding columns to the tables.

• is_enterprise_install: bool (true if it is an org-level installation)
• enterprise_url: Optional[str] (URL; this is available only for org-level installation)
• enterprise_name: Optional[str] (the name of the installed org; this value is just a snapshot data at the timing of installations. So, it can be changed afterwards)
• team_name: Optional[str] (the name of the installed workspace)
• incoming_webhook_channel: Optional[str] (channel name)
• token_type: Optional[str]

Also, since this version, the built-in InstallationStore based authorize functions try to fetch Installation. The Installation object contains Bot data too. So, you will be able to utilize more fields like user_token, thanks to this change.

If your application does not maintain the data when handling Slack app installations, upgrading to this version may result in errors due to this incompatibility. If you need to continue using Bot over Installation data rows, please consider implementing and using your own Authorize classes.

Changes

• #877 #881 Add Org App Support - Thanks @stevegill @seratch
• #875 Typo fix in docs - Thanks @timgates42
• #885 PlainTextInputElement class comment fix - Thanks @jelizaga3-gatech

• All issues/pull requests: https://github.com/slackapi/python-slack-sdk/milestone/4?closed=1
• All changes: v3.0.0...v3.1.0