feature(slack-app): implement support for slash commands

Author: Balu-Varanasi

llmstack/apps/handlers/slack_app.py

@@ -120,11 +120,10 @@ def _get_slack_app_session_id(self, slack_request_payload):
 
     def _get_input_data(self):
         slack_request_payload = self.request.data
-
-        slack_message_type = slack_request_payload["type"]
-        if slack_message_type == "url_verification":
+        slack_request_type = slack_request_payload.get("type")
+        if slack_request_type == "url_verification":
             return {"input": {"challenge": slack_request_payload["challenge"]}}
-        elif slack_message_type == "event_callback":
+        elif slack_request_type == "event_callback":
             payload = process_slack_message_text(
                 slack_request_payload["event"]["text"],
             )
@@ -148,6 +147,31 @@ def _get_input_data(self):
                     ),
                 },
             }
+        # If the request is a command, then the payload will be in the form of a command
+        elif slack_request_payload.get("command"):
+            payload = process_slack_message_text(
+                slack_request_payload["text"],
+            )
+            return {
+                "input": {
+                    "text": slack_request_payload["text"],
+                    "user": slack_request_payload["user_id"],
+                    "slack_user_email": self._slack_user_email,
+                    "token": slack_request_payload["token"],
+                    "team_id": slack_request_payload["team_id"],
+                    "api_app_id": slack_request_payload["api_app_id"],
+                    "team": slack_request_payload["team_id"],
+                    "channel": slack_request_payload["channel_id"],
+                    "text-type": "command",
+                    "ts": "",
+                    **dict(
+                        zip(
+                            list(map(lambda x: x["name"], self.app_data["input_fields"])),
+                            [payload] * len(self.app_data["input_fields"]),
+                        ),
+                    ),
+                },
+            }
         else:
             raise Exception("Invalid Slack message type")
 
@@ -203,8 +227,14 @@ def _is_app_accessible(self):
         is_valid_app_token = self.request.data.get("token") == self.slack_config.get("verification_token")
         is_valid_app_id = self.request.data.get("api_app_id") == self.slack_config.get("app_id")
 
+        is_valid_slash_command = False
+        if self.request.data.get("command") and self.slack_config.get("slash_command_name"):
+            request_slash_command = self.request.data.get("command")
+            configured_slash_command = self.slack_config.get("slash_command_name")
+            is_valid_slash_command = request_slash_command == configured_slash_command
+
         # Validate that the app token, app ID and the request type are all valid.
-        if not (is_valid_app_token and is_valid_app_id and is_valid_request_type):
+        if not (is_valid_app_token and is_valid_app_id and (is_valid_request_type or is_valid_slash_command)):
             raise Exception("Invalid Slack request")
 
         # URL verification is allowed without any further checks

llmstack/apps/integration_configs.py

@@ -51,6 +51,8 @@ class SlackIntegrationConfig(AppIntegrationConfig):
     config_type = "slack"
     is_encrypted = True
     app_id: str = ""
+    slash_command_name: str = ""
+    slash_command_description: str = ""
     bot_token: str = ""
     verification_token: str = ""
     signing_secret: str = ""

llmstack/apps/types/slack.py

@@ -32,6 +32,18 @@ class SlackAppConfigSchema(BaseSchema):
         widget="password",
         description="Signing secret to verify the request from Slack. This secret is available at Features > Basic Information in your app page. More details https://api.slack.com/authentication/verifying-requests-from-slack",
     )
+    slash_command_name: str = Field(
+        default="promptly",
+        title="Slash Command Name",
+        description="The name of the slash command that will be used to trigger the app. Slack commands must start with a slash, be all lowercase, and contain no spaces. Examples: /deploy, /ack, /weather. Ensure that the bot has access to the commands scope under Features > OAuth & Permissions.",
+        required=True,
+    )
+    slash_command_description: str = Field(
+        title="Slash Command Description",
+        default="Promptly App",
+        description="The description of the slash command that will be used to trigger the app.",
+        required=True,
+    )
 
 
 class SlackApp(AppTypeInterface[SlackAppConfigSchema]):

llmstack/client/src/components/apps/AppSlackConfigEditor.jsx

@@ -32,6 +32,18 @@ const slackConfigSchema = {
       description:
         "Signing secret to verify the request from Slack. This secret is available at Features > Basic Information in your app page. More details https://api.slack.com/authentication/verifying-requests-from-slack",
     },
+    slash_command_name: {
+      type: "string",
+      title: "Slash Command Name",
+      description:
+        "The name of the slash command that will be used to trigger the app. Slack commands must start with a slash, be all lowercase, and contain no spaces. Examples: /deploy, /ack, /weather. Ensure that the bot has access to the commands scope under Features > OAuth & Permissions.",
+    },
+    slash_command_description: {
+      type: "string",
+      title: "Slash Command Description",
+      description:
+        "The description of the slash command that will be used to trigger the app.",
+    },
   },
   required: ["app_id", "bot_token", "verification_token", "signing_secret"],
 };
@@ -41,6 +53,14 @@ const slackConfigUISchema = {
     "ui:widget": "text",
     "ui:emptyValue": "",
   },
+  slash_command_name: {
+    "ui:widget": "text",
+    "ui:emptyValue": "",
+  },
+  slash_command_description: {
+    "ui:widget": "text",
+    "ui:emptyValue": "",
+  },
   bot_token: {
     "ui:widget": "password",
     "ui:emptyValue": "",
@@ -63,6 +83,8 @@ export function AppSlackConfigEditor(props) {
   function slackConfigValidate(formData, errors, uiSchema) {
     if (
       formData.app_id ||
+      formData.slash_command_name ||
+      formData.slash_command_description ||
       formData.bot_token ||
       formData.verification_token ||
       formData.signing_secret
@@ -79,6 +101,20 @@ export function AppSlackConfigEditor(props) {
       if (!formData.signing_secret) {
         errors.signing_secret.addError("Signing Secret is required");
       }
+
+      const hasSlashCommand = Boolean(
+        formData.slash_command_name || formData.slash_command_description,
+      );
+      if (hasSlashCommand) {
+        if (!formData.slash_command_name) {
+          errors.slash_command_name.addError("Slash Command Name is required");
+        }
+        if (!formData.slash_command_description) {
+          errors.slash_command_description.addError(
+            "Slash Command Description is required",
+          );
+        }
+      }
     }
 
     return errors;