Package: slackeventsapi
Slack Events API adapter for PythonThe Slack Events Adapter is a Python-based solution to receive and parse events
from Slack’s Events API. This library uses an event emitter framework to allow
you to easily process Slack events by simply attaching functions
to event listeners.This adapter enhances and simplifies Slack’s Events API by incorporating useful best practices, patterns, and opportunities to abstract out common tasks.💡  We wrote ablog post which explains howthe Events API can help you, why we built these tools, and how you can use them to build production-ready Slack apps.⚠️  Important NoticeIf you use this library for Events API handling, you may need to use threads for stable event acknowledgement. Seehttps://github.com/slackapi/python-slack-events-api/issues/84for details.If you’re looking for the best recommended library at this point, check Bolt for Python:https://github.com/slackapi/bolt-pythonThe framework covers not only Events API but also all the latest Slack Platform features.🤖  Installationpipinstallslackeventsapi🤖  App SetupBefore you can use theEvents APIyou mustcreate a Slack App, and turn onEvent Subscriptions.💡  When you add the Request URL to your app’s Event Subscription settings,
Slack will send a request containing achallengecode to verify that your
server is alive. This package handles that URL Verification event for you, so
all you need to do is start the example app, start ngrok and configure your
URL accordingly.✅  Once you have yourRequest URLverified, your app is ready to start
receiving Team Events.🔑  Your server will begin receiving Events from Slack’s Events API as soon as a
user has authorized your app.🤖  Development workflow:Create a Slack app onhttps://api.slack.com/appsAdd abot userfor your appStart the example app on yourRequest URLendpointStart ngrok and copy theHTTPSURLAdd yourRequest URLand subscribe your app to eventsGo to your ngrok URL (e.g.https://myapp12.ngrok.com/) and auth your app🎉 Once your app has been authorized, you will begin receiving Slack Events⚠️  Ngrok is a great tool for developing Slack apps, but we don’t recommend using ngrok
for production apps.🤖  Usage⚠️  Keep your app’s credentials safe!For development, keep them in virtualenv variables.For production, use a secure data store.Never post your app’s credentials to github.SLACK_SIGNING_SECRET=os.environ["SLACK_SIGNING_SECRET"]Create a Slack Event Adapter for receiving actions via the Events APIUsing the built-in Flask server:fromslackeventsapiimportSlackEventAdapterslack_events_adapter=SlackEventAdapter(SLACK_SIGNING_SECRET,endpoint="/slack/events")# Create an event listener for "reaction_added" events and print the emoji name@slack_events_adapter.on("reaction_added")defreaction_added(event_data):emoji=event_data["event"]["reaction"]print(emoji)# Start the server on port 3000slack_events_adapter.start(port=3000)Using your existing Flask instance:fromflaskimportFlaskfromslackeventsapiimportSlackEventAdapter# This `app` represents your existing Flask appapp=Flask(__name__)# An example of one of your Flask app's routes@app.route("/")defhello():return"Hello there!"# Bind the Events API route to your existing Flask app by passing the server# instance as the last param, or with `server=app`.slack_events_adapter=SlackEventAdapter(SLACK_SIGNING_SECRET,"/slack/events",app)# Create an event listener for "reaction_added" events and print the emoji name@slack_events_adapter.on("reaction_added")defreaction_added(event_data):emoji=event_data["event"]["reaction"]print(emoji)# Start the server on port 3000if__name__=="__main__":app.run(port=3000)For a comprehensive list of available SlackEventsand more information onScopes, seehttps://api.slack.com/events-api🤖  Example event listenersSeeexample.pyfor usage examples. This example also utilizes the
SlackClient Web API client.🤔  SupportNeed help? JoinSlack Communityand talk to us in#slack-api.You can alsocreate an Issueright here on GitHub.