Python Slack SDK

The SDK provides specialized packages for different Slack API capabilities. You can use these modules independently or together:

• slack_sdk.web: For calling Web API methods.
• slack_sdk.webhook: For utilizing Incoming Webhooks and response_urls in payloads.
• slack_sdk.signature: For verifying incoming requests from the Slack API server.
• slack_sdk.socket_mode: For receiving and sending messages over Socket Mode connections.
• slack_sdk.audit_logs: For utilizing Audit Logs APIs.
• slack_sdk.scim: For utilizing SCIM APIs.
• slack_sdk.oauth: For implementing the Slack OAuth flow.
• slack_sdk.models: For constructing Block Kit UI components using builders.
• slack_sdk.rtm: For utilizing the RTM API.

By default, AuditLogsClient uses a ConnectionErrorRetryHandler that performs a single retry using exponential backoff and jitter for connectivity-related failures.

To handle rate limiting (HTTP 429), you can append a RateLimitErrorRetryHandler to the client's retry_handlers list. You can also provide a custom list of handlers during client initialization.

To implement a custom handler, inherit from slack_sdk.http_retry.RetryHandler (or AsyncRetryHandler for asyncio) and implement the required logic.

import os
from slack_sdk.audit_logs import AuditLogsClient
from slack_sdk.http_retry.builtin_handlers import RateLimitErrorRetryHandler

client = AuditLogsClient(token=os.environ["SLACK_ORG_ADMIN_USER_TOKEN"])

# Enable rate limited error retries
rate_limit_handler = RateLimitErrorRetryHandler(max_retry_count=1)
client.retry_handlers.append(rate_limit_handler)

To run your application, use the app.start() method. It is recommended to set the logging level to DEBUG during development to see incoming events and API interactions.

if __name__ == "__main__":
    logger = logging.getLogger()
    logger.setLevel(logging.DEBUG)
    logger.addHandler(logging.StreamHandler())
    app.start(3000)

Before running your application, you must configure your Slack bot token and signing secret as environment variables.

1. SLACK_BOT_TOKEN: Use the bot user OAuth token (starting with xoxb-) obtained from your Slack App settings.
2. SLACK_SIGNING_SECRET: Copy the Signing Secret from the Basic Information page under App Credentials in your Slack app configuration.

To run your app locally, you may need a tool like ngrok to tunnel requests from a public URL to your local machine. If using ngrok, append /slack/events to your ngrok URL (e.g., https://abcdef.ngrok.io/slack/events) and use this in your Slack app configuration.

$ export SLACK_BOT_TOKEN='xoxb-XXXXXXXXXXXX-xxxxxxxxxxxx-XXXXXXXXXXXXXXXXXXXXXXXX'
$ export SLACK_SIGNING_SECRET='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
$ python3 app.py

Scopes define what actions your app is allowed to perform. To configure them:

1. Navigate to OAuth & Permissions in the Slack App settings sidebar.
2. Scroll to the Bot Token Scopes section.
3. Click Add an OAuth Scope to add required permissions.

For basic messaging functionality, add the following scopes:

• chat:write: Allows the app to post messages in channels it has joined.
• im:write: Allows the app to post messages in Direct Messages (DMs).

When you upload a file using files_upload_v2 without specifying a channel, the file is uploaded but only visible to the bot. To share it with others, retrieve the file's permalink from the response and post it to a channel using chat_postMessage.

# Retrieve the permalink from the upload response
file_url = new_file.get("file").get("permalink")

# Post the link to a specific channel
new_message = client.chat_postMessage(
    channel="C123456789",
    text=f"Here is the file: {file_url}",
)

After a user authorizes your app, Slack redirects them to your Redirect URL with a code and state parameter. To complete the installation:

1. Retrieve code and state from the request parameters.
2. Verify the state using state_store.consume(state) to ensure it hasn't expired or been used.
3. Exchange the code for an access token by calling WebClient.oauth_v2_access().
4. (Optional) Call WebClient.auth_test(token=bot_token) to retrieve the bot_id and enterprise_url if it is an enterprise installation.
5. Create an Installation object and save it using your InstallationStore.

Install the slack_sdk package using pip. This library requires Python 3.7 or higher.

To check your Python version, use:

python3 --version

$ pip install slack_sdk