@@ -7,11 +7,40 @@ description: Configuration options for the Slack plugin.
 {% hint style="info" %}
 Dispatch ships with support for Slack. Below, is how to configure the Slack plugin to work with `Dispatch`. This plugin is required for core functionality.
 
-The plugin relies on the [Events API](https://api.slack.com/events-api) to receive events for the event types the app is subscribed to. `Dispatch` receives these events at the `/api/v1/events/slack/event` API endpoint. Slack will also send Web requests to the `/api/v1/events/slack/command` and `/api/v1/events/slack/action` API endpoints for slash \(`/`\) commands and interactive components like dialogs and modals. These endpoints must be publicly available in order for the `Dispatch` Slack app to work correctly.
-{% endhint %}
+Dispatch supports both the [Event Mode](https://api.slack.com/events-api) and [Socket Mode](https://api.slack.com/apis/connections/socket).
+
+Which mode should you choose?
+
+- If you have Dispatch deployed behind a firewall use **socket mode**
+- If you are deploying Dispatch publically use **event mode**
+
+## Events Mode
+
+To enable event mode:
+
+- Ensure that the following configuration items are set:
+  - `SLACK_SIGNING_SECRET`
+  - `SLACK_API_BOT_TOKEN`
+
+Additional, event mode requires specific url mapping that must be **publically** available:
+
+- `Dispatch` receives general events at the `/api/v1/events/slack/event` endpoint (reactions).
+- `Dispatch` receives command events at the `/api/v1/events/slack/command` endpoint (`/dispatch-*` commands)
+- `Dispatch` recieves action events at the `/api/v1/events/slack/action` (dialogs and modals) endpoint.
+
+## Socket Mode
+
+To enable socket mode:
+
+- Ensure the following configuration items are set:
+  - `SLACK_SOCKET_MODE_APP_TOKEN`
+
+Socket mode does not require the mapping of endpoints and these values are ingored in socket mode.
 
 ## Slack Configuration
 
+Both `socket mode` or `event mode` you will need set the following configuration items within slack itself.
+
 ### Event Subscriptions
 
 To enable Dispatch to process Slack events, ensure your bot is subscribed to the following events:
@@ -90,6 +119,10 @@ groups:read
 
 > Secret used to verify signatures included on each HTTP request that Slack sends. Slack refers to this as your "Signing Secret."
 
+#### `SLACK_SOCKET_MODE_APP_TOKEN` \[Required. Secret: True\]
+
+> Socket specific app token, used to authenticate to the websocket api.
+
 #### `SLACK_APP_USER_SLUG` \[Required\]
 
 > Specifies the Slack app's bot user id, so Dispatch can filter events generated by the app's user \(e.g. message posted in the channel\). You can use the [auth.test](https://api.slack.com/methods/auth.test/test) endpoint and the app's bot token \(`xoxb-*`\) to get the bot user id \(`UXXXXXXXX`\)."
 
@@ -34,7 +34,7 @@ schedule
 sentry-asgi
 sentry-sdk
 sh
-slackclient
+slack_sdk
 spacy
 sqlalchemy
 sqlalchemy-filters
 
@@ -10,23 +10,25 @@
 
 
 # revision identifiers, used by Alembic.
-revision = '72c7fa0ce0a3'
-down_revision = '466823f3046e'
+revision = "72c7fa0ce0a3"
+down_revision = "466823f3046e"
 branch_labels = None
 depends_on = None
 
 
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.add_column('workflow', sa.Column('plugin_id', sa.Integer(), nullable=True))
-    op.create_foreign_key(None, 'workflow', 'plugin', ['plugin_id'], ['id'])
-    op.drop_column('workflow', 'plugin_slug')
+    op.add_column("workflow", sa.Column("plugin_id", sa.Integer(), nullable=True))
+    op.create_foreign_key(None, "workflow", "plugin", ["plugin_id"], ["id"])
+    op.drop_column("workflow", "plugin_slug")
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.add_column('workflow', sa.Column('plugin_slug', sa.VARCHAR(), autoincrement=False, nullable=True))
-    op.drop_constraint(None, 'workflow', type_='foreignkey')
-    op.drop_column('workflow', 'plugin_id')
+    op.add_column(
+        "workflow", sa.Column("plugin_slug", sa.VARCHAR(), autoincrement=False, nullable=True)
+    )
+    op.drop_constraint(None, "workflow", type_="foreignkey")
+    op.drop_column("workflow", "plugin_id")
     # ### end Alembic commands ###
@@ -10,57 +10,94 @@
 
 
 # revision identifiers, used by Alembic.
-revision = '99f3dec93615'
-down_revision = '9f927a8e4679'
+revision = "99f3dec93615"
+down_revision = "9f927a8e4679"
 branch_labels = None
 depends_on = None
 
 
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.create_table('workflow_incident_priority',
-    sa.Column('incident_priority_id', sa.Integer(), nullable=False),
-    sa.Column('workflow_id', sa.Integer(), nullable=False),
-    sa.ForeignKeyConstraint(['incident_priority_id'], ['incident_priority.id'], ),
-    sa.ForeignKeyConstraint(['workflow_id'], ['workflow.id'], ),
-    sa.PrimaryKeyConstraint('incident_priority_id', 'workflow_id')
+    op.create_table(
+        "workflow_incident_priority",
+        sa.Column("incident_priority_id", sa.Integer(), nullable=False),
+        sa.Column("workflow_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["incident_priority_id"],
+            ["incident_priority.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["workflow_id"],
+            ["workflow.id"],
+        ),
+        sa.PrimaryKeyConstraint("incident_priority_id", "workflow_id"),
     )
-    op.create_table('workflow_incident_type',
-    sa.Column('incident_type_id', sa.Integer(), nullable=False),
-    sa.Column('workflow_id', sa.Integer(), nullable=False),
-    sa.ForeignKeyConstraint(['incident_type_id'], ['incident_type.id'], ),
-    sa.ForeignKeyConstraint(['workflow_id'], ['workflow.id'], ),
-    sa.PrimaryKeyConstraint('incident_type_id', 'workflow_id')
+    op.create_table(
+        "workflow_incident_type",
+        sa.Column("incident_type_id", sa.Integer(), nullable=False),
+        sa.Column("workflow_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["incident_type_id"],
+            ["incident_type.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["workflow_id"],
+            ["workflow.id"],
+        ),
+        sa.PrimaryKeyConstraint("incident_type_id", "workflow_id"),
     )
-    op.create_table('workflow_term',
-    sa.Column('term_id', sa.Integer(), nullable=False),
-    sa.Column('workflow_id', sa.Integer(), nullable=False),
-    sa.ForeignKeyConstraint(['term_id'], ['term.id'], ),
-    sa.ForeignKeyConstraint(['workflow_id'], ['workflow.id'], ),
-    sa.PrimaryKeyConstraint('term_id', 'workflow_id')
+    op.create_table(
+        "workflow_term",
+        sa.Column("term_id", sa.Integer(), nullable=False),
+        sa.Column("workflow_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["term_id"],
+            ["term.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["workflow_id"],
+            ["workflow.id"],
+        ),
+        sa.PrimaryKeyConstraint("term_id", "workflow_id"),
     )
-    op.create_table('workflow_instance_artifact',
-    sa.Column('document_id', sa.Integer(), nullable=False),
-    sa.Column('workflow_instance_id', sa.Integer(), nullable=False),
-    sa.ForeignKeyConstraint(['document_id'], ['document.id'], ),
-    sa.ForeignKeyConstraint(['workflow_instance_id'], ['workflow_instance.id'], ),
-    sa.PrimaryKeyConstraint('document_id', 'workflow_instance_id')
+    op.create_table(
+        "workflow_instance_artifact",
+        sa.Column("document_id", sa.Integer(), nullable=False),
+        sa.Column("workflow_instance_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["document_id"],
+            ["document.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["workflow_instance_id"],
+            ["workflow_instance.id"],
+        ),
+        sa.PrimaryKeyConstraint("document_id", "workflow_instance_id"),
     )
-    op.drop_table('workflow_instance_artifacts')
+    op.drop_table("workflow_instance_artifacts")
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.create_table('workflow_instance_artifacts',
-    sa.Column('document_id', sa.INTEGER(), autoincrement=False, nullable=False),
-    sa.Column('workflow_instance_id', sa.INTEGER(), autoincrement=False, nullable=False),
-    sa.ForeignKeyConstraint(['document_id'], ['document.id'], name='workflow_instance_artifacts_document_id_fkey'),
-    sa.ForeignKeyConstraint(['workflow_instance_id'], ['workflow_instance.id'], name='workflow_instance_artifacts_workflow_instance_id_fkey'),
-    sa.PrimaryKeyConstraint('document_id', 'workflow_instance_id', name='workflow_instance_artifacts_pkey')
+    op.create_table(
+        "workflow_instance_artifacts",
+        sa.Column("document_id", sa.INTEGER(), autoincrement=False, nullable=False),
+        sa.Column("workflow_instance_id", sa.INTEGER(), autoincrement=False, nullable=False),
+        sa.ForeignKeyConstraint(
+            ["document_id"], ["document.id"], name="workflow_instance_artifacts_document_id_fkey"
+        ),
+        sa.ForeignKeyConstraint(
+            ["workflow_instance_id"],
+            ["workflow_instance.id"],
+            name="workflow_instance_artifacts_workflow_instance_id_fkey",
+        ),
+        sa.PrimaryKeyConstraint(
+            "document_id", "workflow_instance_id", name="workflow_instance_artifacts_pkey"
+        ),
     )
-    op.drop_table('workflow_instance_artifact')
-    op.drop_table('workflow_term')
-    op.drop_table('workflow_incident_type')
-    op.drop_table('workflow_incident_priority')
+    op.drop_table("workflow_instance_artifact")
+    op.drop_table("workflow_term")
+    op.drop_table("workflow_incident_type")
+    op.drop_table("workflow_incident_priority")
     # ### end Alembic commands ###
@@ -10,19 +10,19 @@
 
 
 # revision identifiers, used by Alembic.
-revision = '9f927a8e4679'
-down_revision = '995a59897e01'
+revision = "9f927a8e4679"
+down_revision = "995a59897e01"
 branch_labels = None
 depends_on = None
 
 
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.add_column('workflow_instance', sa.Column('parameters', sa.JSON(), nullable=True))
+    op.add_column("workflow_instance", sa.Column("parameters", sa.JSON(), nullable=True))
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.drop_column('workflow_instance', 'parameters')
+    op.drop_column("workflow_instance", "parameters")
     # ### end Alembic commands ###
@@ -4,6 +4,7 @@
 
 import click
 import uvicorn
+import asyncio
 from alembic import command as alembic_command
 from alembic.config import Config as AlembicConfig
 from tabulate import tabulate
@@ -18,6 +19,8 @@
 from .scheduler import scheduler
 from .logging import configure_logging
 
+from dispatch.plugins.dispatch_slack import socket_mode
+
 os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"
 
 log = logging.getLogger(__name__)
@@ -585,6 +588,12 @@ def run_server(log_level):
 dispatch_server.add_command(uvicorn.main, name="start")
 
 
+@dispatch_server.command("slack")
+def run_slack_websocket():
+    """Runs the slack websocket process."""
+    asyncio.run(socket_mode.run_websocket_process())
+
+
 @dispatch_server.command("shell")
 @click.argument("ipython_args", nargs=-1, type=click.UNPROCESSED)
 def shell(ipython_args):
 
@@ -33,7 +33,9 @@ def get_by_channel_id_ignoring_channel_type(db_session, channel_id: str) -> Opti
             # The channel type has changed. We update the channel id in the database
             conversation_in = ConversationUpdate(channel_id=channel_id)
             update(
-                db_session=db_session, conversation=conversation, conversation_in=conversation_in,
+                db_session=db_session,
+                conversation=conversation,
+                conversation_in=conversation_in,
             )
 
             event_service.log(
 
@@ -135,7 +135,9 @@ async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -
 # we print all the registered API routes to the console
 table = []
 for r in api_router.routes:
-    auth = any(d.dependency.__name__ == "get_current_user" for d in r.dependencies)  # TODO this is fragile
+    auth = any(
+        d.dependency.__name__ == "get_current_user" for d in r.dependencies
+    )  # TODO this is fragile
     table.append([r.path, auth, ",".join(r.methods)])
 
 log.debug("Available Endpoints \n" + tabulate(table, headers=["Path", "Authenticated", "Methods"]))
@@ -12,7 +12,9 @@ class Metrics(object):
 
     def __init__(self):
         if not METRIC_PROVIDERS:
-            log.info("No metric providers defined via METRIC_PROVIDERS env var. Metrics will not be sent.")
+            log.info(
+                "No metric providers defined via METRIC_PROVIDERS env var. Metrics will not be sent."
+            )
         else:
             self._providers = METRIC_PROVIDERS
 
 
@@ -73,7 +73,7 @@ def update_notification(
     *,
     db_session: Session = Depends(get_db),
     notification_id: int,
-    notification_in: NotificationUpdate
+    notification_in: NotificationUpdate,
 ):
     """
     Update a notification by id.