Issue Tracker for questions, bug reports, feature requests, and general discussion related to Bolt for Python.The following are the best ways to get assistance working through your issue: If you otherwise get stuck, we're here to help. Also, all the Python module documents of this library are available here. The documentation has more information on basic and advanced concepts for Bolt for Python. If you'd prefer another async Web framework (e.g., Sanic, FastAPI, Starlette), take a look at the built-in adapters and their corresponding examples. 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.Īpps can be run the same way as the syncronous example above. command( '/hello-bolt-python') async def command( ack, body, respond): event( 'app_mention') async def event_test( body, say, logger):Īwait say( 'What's app. # Import the async app instead of the regular one from slack_bolt. Within async apps, you can use the async/await pattern. If you'd prefer to build your app with asyncio, you can import the AIOHTTP library and call the AsyncApp constructor. The built-in logging.Logger instance you can use in middleware/listeners. For multi-workspace installations, the token is returned by using the OAuth library, or manually using the authorize function. For single-workspace installations, the token is provided to the constructor. Web API client that uses the token associated with the event. say accepts simple strings (for plain-text messages) and dictionaries (for messages containing blocks). This argument is only available when the listener is triggered for events that contain a channel_id (the most common being message events). Utility function to send a message to the channel associated with the incoming event. Utility function that responds to incoming events if it contains a response_url (shortcuts, actions, and slash commands). ack returns a promise that resolves when complete. ack exists for all actions, shortcuts, view submissions, slash command and options requests. Middleware can add additional context before the event is passed to listeners.įunction that must be called to acknowledge that your app received the incoming event. This dictionary contains data about the event and app, such as the botId. An easy way to understand what's in a payload is to log it.Įvent context. For example, if you were building a message() listener, you could use the payload and message arguments interchangably. The payload dictionary is also accessible via the alias corresponding to the listener ( message, event, action, shortcut, view, command, or options). For a block action, it will be the action from within the actions list. For example, for an Events API event, payload will be the event type structure. The payload structure depends on the listener.

Some accessory data is only available outside of the payload (such as trigger_id and authorizations).Ĭontents of the incoming event. Argumentĭictionary that contains the entire body of the request (superset of payload). If you'd like to access arguments off of a single object, you can use args, an slack_bolt.kwargs_injection.Args instance that contains all available arguments for that event. These functions are called with a set of arguments, each of which can be used in any order. Most of the app's functionality will be inside listener functions (the fn parameters above). event( event_type) def handle_event( event):

Pip install slack sdk