update

Author: vegeris

messaging/work-objects/README.md

@@ -6,32 +6,54 @@ You can also [post](https://docs.slack.dev/messaging/work-objects/#implementatio
 
 Read the [docs](https://docs.slack.dev/messaging/work-objects/) to learn more!
 
-## Running locally
+## Setup
 
-### 0. Create an app
+### Option 1: Create a new app with the Slack CLI
 
-Create an app and add `myappdomain.com`as an [app unfurl domain](https://docs.slack.dev/messaging/unfurling-links-in-messages/#configuring_domains)  (or update the unfurl URLs in `metadata.py` with your domain). Also enable [Work Object Previews](https://docs.slack.dev/messaging/work-objects/#implementation) for your app.
+```bash
+slack init && slack run
+```
 
-### 1. Setup environment variables
+### Option 2: Create a Slack App in the UI and copy over your secrets
 
-```zsh
-# Replace with your tokens
-export SLACK_BOT_TOKEN=<your-bot-token>
-export SLACK_APP_TOKEN=<your-app-level-token>
-```
+#### Create the app
+
+Create an app and add `myappdomain.com`as an [app unfurl domain](https://docs.slack.dev/messaging/unfurling-links-in-messages/#configuring_domains) (or update the unfurl URLs in `metadata.py` with your domain). Also enable [Work Object Previews](https://docs.slack.dev/messaging/work-objects/#implementation) for your app.
+
+1. Go to [https://api.slack.com/apps](https://api.slack.com/apps)
+2. Click **"Create New App"**
+3. Choose **"From an app manifest"**
+4. Select your workspace
+5. Copy the contents of `manifest.json` and paste it into the manifest editor
+6. Review the configuration and click **"Create"**
+
+#### Configure environment variables
 
-### 2. Setup your local project
+1. Copy the environment variables template:
+   ```bash
+   cp .env.sample .env
+   ```
 
-```zsh
+2. Fill in your Slack credentials in `.env`:
+   ```
+   SLACK_BOT_TOKEN=xoxb-your-bot-token
+   SLACK_APP_TOKEN=xapp-your-app-token
+   ```
+
+   You can find these values in your app's settings:
+   - **Bot Token**: OAuth & Permissions → Bot User OAuth Token
+   - **App Token**: Basic Information → App-Level Tokens (create one with `connections:write` scope)
+
+#### Install dependencies and run the app
+
+```bash
 # Setup virtual environment
 python3 -m venv .venv
 source .venv/bin/activate
 
 # Install the dependencies
 pip install -r requirements.txt
-```
 
-### 3. Start the server
-```zsh
-python3 src/app.py
+# Start the server
+python3 app.py
 ```

messaging/work-objects/src/app.py messaging/work-objects/app.pymessaging/work-objects/src/app.py renamed to messaging/work-objects/app.py

@@ -1,10 +1,11 @@
 import os
+import sys
 import logging
 from slack_bolt import App
 from slack_bolt.adapter.socket_mode import SocketModeHandler
 from slack_sdk import WebClient
 from slack_sdk.models.metadata import EventAndEntityMetadata
-from metadata import sample_entities
+from metadata import sample_entities, sample_task_unfurl_url, sample_file_unfurl_url
 
 
 # Initializes your app with your bot token
@@ -64,11 +65,13 @@ def work_object_edit_callback(view: dict, body: dict, client: WebClient, logger:
         entity_url = view["entity_url"]
         entity = sample_entities[entity_url]
 
-        attributes = entity.entity_payload.entity_attributes
-        attributes.title.text = view["state"]["values"]["title"]["title.input"]["value"]
-        entity.entity_payload.entity_attributes = attributes
-        
-        entity.entity_payload.fields.description.value = view["state"]["values"]["description"]["description.input"]["value"]
+        if "title" in view["state"]["values"]:
+            attributes = entity.entity_payload.entity_attributes
+            attributes.title.text = view["state"]["values"]["title"]["title.input"]["value"]
+            entity.entity_payload.entity_attributes = attributes
+
+        if "description" in view["state"]["values"]: 
+            entity.entity_payload.fields.description.value = view["state"]["values"]["description"]["description.input"]["value"]
 
         if entity is not None:
             client.entity_presentDetails(
@@ -85,4 +88,10 @@ def work_object_edit_callback(view: dict, body: dict, client: WebClient, logger:
 
 # Start your app
 if __name__ == "__main__":
-    SocketModeHandler(app, os.environ["SLACK_APP_TOKEN"]).start()
+    try:
+        print("Try sharing this link: ", sample_task_unfurl_url)
+        print("Or this link: ", sample_file_unfurl_url)
+        SocketModeHandler(app, os.environ["SLACK_APP_TOKEN"]).start()
+    except Exception as error:
+        print(f"Failed to start app: {error}", file=sys.stderr)
+        sys.exit(1)

messaging/work-objects/manifest.json

@@ -1,30 +1,22 @@
 {
   "display_information": {
-    "name": "Work Objects for Bolt Python App"
+    "name": "work_objects_python",
+    "description": "A sample app demonstrating Slack Work Objects functionality"
   },
   "features": {
     "rich_previews": {
       "is_active": true,
-      "entity_types": [
-        "slack#/entities/task"
-      ]
-    },
-    "unfurl_domains": [
-      "tmpdomain.com"
-    ],
-    "app_home": {
-      "home_tab_enabled": false,
-      "messages_tab_enabled": true,
-      "messages_tab_read_only_enabled": false
+      "entity_types": ["slack#/entities/task", "slack#/entities/file"]
     },
+    "unfurl_domains": ["work-objects-python.com"],
     "bot_user": {
-      "display_name": "WorkObjectsApp",
+      "display_name": "work_objects_python_bot",
       "always_online": true
     }
   },
   "oauth_config": {
     "scopes": {
-      "bot": ["channels:history", "chat:write", "im:history", "links:read", "links:write"]
+      "bot": ["chat:write", "links:read", "links:write"]
     }
   },
   "settings": {
@@ -38,4 +30,4 @@
     "socket_mode_enabled": true,
     "token_rotation_enabled": false
   }
-}
+}

messaging/work-objects/src/metadata.py messaging/work-objects/metadata.pymessaging/work-objects/src/metadata.py renamed to messaging/work-objects/metadata.py

@@ -18,8 +18,8 @@
 )
 
 # Update the URL here to match your app's domain
-sample_task_unfurl_url = "https://myappdomain.com/task"
-sample_file_unfurl_url = "https://myappdomain.com/file"
+sample_task_unfurl_url = "https://work-objects-python.com/task"
+sample_file_unfurl_url = "https://work-objects-python.com/file"
 
 sample_entities = {
     sample_task_unfurl_url: EntityMetadata(

messaging/work-objects/requirements.txt

@@ -1,5 +1,6 @@
 mypy==1.18.2
 pytest==9.0.1
 ruff==0.14.5
-#slack_sdk==3.39.0
+slack_sdk>=3.39.0
+slack-bolt
 slack-cli-hooks<1.0.0