Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

The Bolt Framework for Python

Project description

Bolt for Python (still in beta)

Python Version pypi package Build Status Codecov

A Python framework to build Slack apps in a flash with the latest platform features. Check the document and samples to know how to use this framework.


# Python 3.6+ required
python -m venv .venv
source .venv/bin/activate

pip install -U pip
pip install slack_bolt

First Bolt App (

Create an app by calling a constructor, which is a top-level export.

import logging

from slack_bolt import App

# export SLACK_BOT_TOKEN=xoxb-***
app = App()

# Events API:
def event_test(say):
    say("What's up?")

# Interactivity:
# @app.command("/hello-bolt-python")
def open_modal(ack, client, logger, body):
    # acknowledge the incoming request from Slack immediately
    # open a modal
    api_response = client.views_open(
            "type": "modal",
            "callback_id": "view-id",
            "title": {
                "type": "plain_text",
                "text": "My App",
            "submit": {
                "type": "plain_text",
                "text": "Submit",
            "blocks": [
                    "type": "input",
                    "block_id": "b",
                    "element": {
                        "type": "plain_text_input",
                        "action_id": "a"
                    "label": {
                        "type": "plain_text",
                        "text": "Label",

def view_submission(ack, view, logger):
    # Prints {'b': {'a': {'type': 'plain_text_input', 'value': 'Your Input'}}}["state"]["values"])

if __name__ == "__main__":
    app.start(3000)  # POST http://localhost:3000/slack/events

Run the Bolt App

export SLACK_BOT_TOKEN=xoxb-***

# in another terminal
ngrok http 3000

AsyncApp Setup

If you prefer building Slack apps using asyncio, you can go with AsyncApp instead. You can use async/await style for everything in the app. To use AsyncApp, AIOHTTP library is required for asynchronous Slack Web API calls and the default web server.

# Python 3.6+ required
python -m venv .venv
source .venv/bin/activate

pip install -U pip
# aiohttp is required
pip install slack_bolt aiohttp

Import slack_bolt.async_app.AsyncApp instead of slack_bolt.App. All middleware/listeners must be async functions. Inside the functions, all utility methods such as ack, say, and respond requires await keyword.

from slack_bolt.async_app import AsyncApp

app = AsyncApp()

async def event_test(body, say, logger):
    await say("What's up?")

async def command(ack, body, respond):
    await ack()
    await respond(f"Hi <@{body['user_id']}>!")

if __name__ == "__main__":

Starting the app is exactly the same with the way using slack_bolt.App.

export SLACK_BOT_TOKEN=xoxb-***

# in another terminal
ngrok http 3000

If you want to use another async Web framework (e.g., Sanic, FastAPI, Starlette), take a look at the built-in adapters and their samples.


We are keen to hear your feedback. Please feel free to submit an issue!


The MIT License

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for slack-bolt, version 0.6.2a0
Filename, size File type Python version Upload date Hashes
Filename, size slack_bolt-0.6.2a0-py2.py3-none-any.whl (108.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size slack_bolt-0.6.2a0.tar.gz (55.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page