Flask-Slack-Events 0.0.2

Installation

Install last stable version from Pypi:

pip install flask-slack-events

Create a Slack bot user

See the Slack’s documentation for further guidance on creating your bot (step 1).

Within the Basic Information about your application, copy the Signing Secret necessary to verify requests from Slack.

Configure your Application

You should create a SlackManager object within your application:

slack_manager = SlackManager()

Configure your application object updating the SLACK_SIGNING_SECRET key with the value obtained in the previous step 1:

app.config['SLACK_SIGNING_SECRET'] = '<your Signing Secret>'

Once the actual application object has been created, you can configure it for SlackManager object with:

slack_manager.init_app(app)

Configure your Slack Bot

Continue with the Slacks’s documentation to setting up the Events API (step 2) and enter the URL to receive the subscriptions joining your host and the relative path /slack/events:

Finally, install your bot to a workspace (step 3).

How it Works

Now in order to subscribe to Slack Events, use the SlackManager.on decorator:

# Reply to only the message events that mention your bot

@slack_manager.on('app_mention')
def reply_to_app_mention(sender, data, **extra):
    event = data['event']

    slack_client.api_call(
        'chat.postMessage',
        channel=event['channel'],
        text=f":robot_face: Hello <@{event['user']}>!")

Context Processors

To inject new variables automatically into the context of a handler, context processors exist in Flask-Slack-Events.

A context processor is a function that returns a dictionary:

@slack_manager.context_processor
def context_processor(data):
    return dict(my_bot_id='UAZ02BCBH')

The injected variables will be sent as an extra argument for each event handler f(sender, data, **extra).

Dispatch Events Asynchronously

Some event handlers can delay the execution of another, to avoid this you can configure the event dispatcher and call handlers asynchronously:

@slack_manager.dispatch_event_handler
def async_event_dispatcher(sender, data, handlers, **extra):
    for handler in handlers:
        task(handler)(data, **extra)

Subscribe to Signals

The following signals are sended internally by Flask-Slack-Events:

SlackManager Handlers

The following handlers are used internally by Flask-Slack-Events:

Configuration

The following configuration values are used internally by Flask-Slack-Events:

Marvin the Paranoid Android

Marvin is a Slack Bot layout for Flask to develop Slack Event handlers and deploy on AWS Lambda + API Gateway