A framework to build Slack apps using Python
A Python framework to build Slack apps in a flash with the latest platform features. Read the getting started guide and look at our code examples to learn how to build apps using Bolt.
# Python 3.6+ required python -m venv .venv source .venv/bin/activatepip install -U pip pip install slack_bolt
Create a Bolt for Python app by calling a constructor, which is a top-level export. If you'd prefer, you can create an async app.
import logging logging.basicConfig(level=logging.DEBUG)from slack_bolt import App
export SLACK_SIGNING_SECRET=***
export SLACK_BOT_TOKEN=xoxb-***
app = App()
Add functionality here
if name == "main": app.start(3000) # POST http://localhost:3000/slack/events
export SLACK_SIGNING_SECRET=*** export SLACK_BOT_TOKEN=xoxb-*** python app.pyin another terminal
ngrok http 3000
Apps typically react to a collection of incoming events, which can correspond to Events API events, actions, shortcuts, slash commands or options requests. For each type of request, there's a method to build a listener function.
# Listen for an event from the Events API app.event(event_type, fn)Convenience method to listen to only
message
events using a string or re.Patternapp.message([pattern ,] fn)
Listen for an action from a Block Kit element (buttons, select menus, date pickers, etc)
app.action(action_id, fn)
Listen for dialog submissions
app.action({"callback_id": callbackId}, fn)
Listen for a global or message shortcuts
app.shortcut(callback_id, fn)
Listen for slash commands
app.command(command_name, fn)
Listen for view_submission modal events
app.view(callback_id, fn)
Listen for options requests (from select menus with an external data source)
app.options(action_id, fn)
The recommended way to use these methods are decorators:
@app.event(event_type) def handle_event(event): pass
Most of the app's functionality will be inside listener functions (the
fnparameters above). These functions are called with a set of arguments, each of which can be used in any order. If you'd like to access arguments off of a single object, you can use
args, an
slack_bolt.kwargs_injection.Argsinstance that contains all available arguments for that event.
| Argument | Description | | :---: | :--- | |
body| Dictionary that contains the entire body of the request (superset of
payload). Some accessory data is only available outside of the payload (such as
trigger_idand
authorizations). |
payload| Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event,
payloadwill be the event type structure. For a block action, it will be the action from within the
actionslist. The
payloaddictionary is also accessible via the alias corresponding to the listener (
message,
event,
action,
shortcut,
view,
command, or
options). For example, if you were building a
message()listener, you could use the
payloadand
messagearguments interchangably. An easy way to understand what's in a payload is to log it. | |
context| Event context. This dictionary contains data about the event and app, such as the
botId. Middleware can add additional context before the event is passed to listeners. |
ack| Function that must be called to acknowledge that your app received the incoming event.
ackexists for all actions, shortcuts, view submissions, slash command and options requests.
ackreturns a promise that resolves when complete. Read more in Acknowledging events. |
respond| Utility function that responds to incoming events if it contains a
response_url(shortcuts, actions, and slash commands). |
say| Utility function to send a message to the channel associated with the incoming event. This argument is only available when the listener is triggered for events that contain a
channel_id(the most common being
messageevents).
sayaccepts simple strings (for plain-text messages) and dictionaries (for messages containing blocks). |
client| Web API client that uses the token associated with the event. For single-workspace installations, the token is provided to the constructor. For multi-workspace installations, the token is returned by using the OAuth library, or manually using the
authorizefunction. |
logger| The built-in
logging.Loggerinstance you can use in middleware/listeners.
If you'd prefer to build your app with asyncio, you can import the AIOHTTP library and call the
AsyncAppconstructor. Within async apps, you can use the async/await pattern.
# Python 3.6+ required python -m venv .venv source .venv/bin/activatepip install -U pip
aiohttp is required
pip install slack_bolt aiohttp
In async apps, all middleware/listeners must be async functions. When calling utility methods (like
ackand
say) within these functions, it's required to use the
awaitkeyword.
# Import the async app instead of the regular one from slack_bolt.async_app import AsyncAppapp = AsyncApp()
@app.event("app_mention") async def event_test(body, say, logger): logger.info(body) await say("What's up?")
@app.command("/hello-bolt-python") async def command(ack, body, respond): await ack() await respond(f"Hi !")
if name == "main": app.start(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 examples.
The documentation has more information on basic and advanced concepts for Bolt for Python.
If you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue:
[email protected]