add work objects sample

Author: vegeris

messaging/README.md

@@ -0,0 +1,9 @@
+# Messaging
+
+Core Slack functionality!
+
+Read the [docs](https://docs.slack.dev/messaging/) to learn about messaging in Slack.
+
+## What's on display
+
+- **[Work Objects](https://docs.slack.dev/messaging/work-objects/)**: Preview and interact with your app data in Slack.

messaging/work-objects/.gitignore

@@ -0,0 +1,6 @@
+__pycache__
+.mypy_cache
+.pytest_cache
+.ruff_cache
+.venv
+.slack

messaging/work-objects/README.md

@@ -0,0 +1,33 @@
+# Work Objects Showcase
+
+Your app can respond to links being shared in Slack with Work Object metadata to display a link preview. Users can click the preview to view authenticated data in the flexpane. If supported, users can edit app data directly from the flexpane.
+
+You can also [post](https://docs.slack.dev/messaging/work-objects/#implementation-notifications) Work Object metadata directly with `chat.postMessage`, without a link being shared.
+
+Read the [docs](https://docs.slack.dev/messaging/work-objects/) to learn more!
+
+## Running locally
+
+### 1. Setup environment variables
+
+```zsh
+# Replace with your tokens
+export SLACK_BOT_TOKEN=<your-bot-token>
+export SLACK_APP_TOKEN=<your-app-level-token>
+```
+
+### 2. Setup your local project
+
+```zsh
+# 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
+```

messaging/work-objects/manifest.json

@@ -0,0 +1,41 @@
+{
+  "display_information": {
+    "name": "Work Objects for Bolt Python App"
+  },
+  "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
+    },
+    "bot_user": {
+      "display_name": "WorkObjectsApp",
+      "always_online": true
+    }
+  },
+  "oauth_config": {
+    "scopes": {
+      "bot": ["channels:history", "chat:write", "im:history", "links:read", "links:write"]
+    }
+  },
+  "settings": {
+    "event_subscriptions": {
+      "bot_events": ["link_shared", "entity_details_requested"]
+    },
+    "interactivity": {
+      "is_enabled": true
+    },
+    "org_deploy_enabled": true,
+    "socket_mode_enabled": true,
+    "token_rotation_enabled": false
+  }
+}

messaging/work-objects/requirements.txt

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

messaging/work-objects/src/__init__.py

@@ -0,0 +1,88 @@
+import os
+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
+
+
+# Initializes your app with your bot token
+app = App(token=os.environ.get("SLACK_BOT_TOKEN"))
+
+
+# Listens for the link_shared event
+# https://docs.slack.dev/reference/events/link_shared/
+@app.event("link_shared")
+def link_shared_callback(event: dict, client: WebClient, logger: logging.Logger):
+    try:
+        for link in event["links"]:
+            entity = sample_entities[link["url"]]
+            if entity is not None:
+                client.chat_unfurl(
+                    channel=event["channel"],
+                    ts=event["message_ts"],
+                    metadata=EventAndEntityMetadata(entities=[entity]),
+                )
+            else:
+                logger.info("No entity found with URL " + link)
+    except Exception as e:
+        logger.error(
+            f"An error occurred while handling the entity_details_requested event: {type(e).__name__} - {str(e)}",
+            exc_info=e,
+        )
+
+
+# Listens for the entity_details_requested event, which is sent when a user opens the flexpane
+# https://docs.slack.dev/reference/events/entity_details_requested/
+@app.event("entity_details_requested")
+def entity_details_callback(event: dict, client: WebClient, logger: logging.Logger):
+    try:
+        entity_url = event["entity_url"]
+        entity = sample_entities[entity_url]
+        if entity is not None:
+            client.entity_presentDetails(
+                trigger_id=event["trigger_id"], metadata=entity
+            )
+        else:
+            logger.info("No entity found with URL " + entity_url)
+    except Exception as e:
+        logger.error(
+            f"An error occurred while handling the entity_details_requested event: {type(e).__name__} - {str(e)}",
+            exc_info=e,
+        )
+
+
+# Listens for the view_submission event sent when the user submits edits in the flexpane
+# https://docs.slack.dev/tools/bolt-js/concepts/view-submissions/
+# https://docs.slack.dev/messaging/work-objects/#editing-view-submission
+@app.view_submission("work-object-edit")
+def work_object_edit_callback(view: dict, body: dict, client: WebClient, logger: logging.Logger, ack):
+    try:
+        ack()
+
+        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 entity is not None:
+            client.entity_presentDetails(
+                trigger_id=body["trigger_id"], metadata=entity
+            )
+        else:
+            logger.info("No entity found with URL " + entity_url)
+    except Exception as e:
+        logger.error(
+            f"An error occurred while handling the entity_details_requested event: {type(e).__name__} - {str(e)}",
+            exc_info=e,
+        )
+
+
+# Start your app
+if __name__ == "__main__":
+    SocketModeHandler(app, os.environ["SLACK_APP_TOKEN"]).start()

messaging/work-objects/src/app.py

@@ -0,0 +1,51 @@
+from slack_sdk.models.metadata import (
+    EntityMetadata,
+    EntityType,
+    ExternalRef,
+    EntityPayload,
+    EntityAttributes,
+    EntityTitle,
+    TaskEntityFields,
+    EntityStringField,
+    EntityTitle,
+    EntityAttributes,
+    TaskEntityFields,
+    EntityStringField,
+    EntityEditSupport,
+    EntityCustomField,
+    ExternalRef,
+)
+
+# Update the URL here to match your app's domain
+sample_task_unfurl_url = "https://wo-python-nov2025.com/task"
+
+sample_entities = {
+    sample_task_unfurl_url: EntityMetadata(
+        entity_type="slack#/entities/task",
+        url=sample_task_unfurl_url,
+        app_unfurl_url=sample_task_unfurl_url,
+        external_ref=ExternalRef(id="sample_task_id"),
+        entity_payload=EntityPayload(
+            attributes=EntityAttributes(
+                title=EntityTitle(
+                    text="My Title",
+                    edit=EntityEditSupport(enabled=True),
+                )
+            ),
+            fields=TaskEntityFields(
+                description=EntityStringField(
+                    value="Hello World!",
+                    edit=EntityEditSupport(enabled=True)
+                    )
+                ),
+            custom_fields=[
+                EntityCustomField(
+                    key="hello-world",
+                    label="hello-world",
+                    value="hello-world",
+                    type="string",
+                )
+            ],
+        ),
+    )
+}