Updated from Slack docs, 2025/10/21

Author: Slack API Ref Buildbot

docs.slack.dev/events/events.json

@@ -429,6 +429,14 @@
       "RTM"
     ]
   },
+  {
+    "name": "entity_details_requested",
+    "description": "This event is sent to your app when a user clicks on a Work Object unfurl or refreshes the flexpane",
+    "scopes": [],
+    "APIs": [
+      "Events"
+    ]
+  },
   {
     "name": "external_org_migration_finished",
     "description": "An enterprise org migration has finished on an external workspace",

docs.slack.dev/methods/chat.unfurl.json

@@ -15,10 +15,7 @@
   "args": {
     "type": "object",
     "required": [
-      "token",
-      "channel",
-      "ts",
-      "unfurls"
+      "token"
     ],
     "properties": {
       "token": {
@@ -37,7 +34,7 @@
         "type": "string"
       },
       "unfurls": {
-        "desc": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.",
+        "desc": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. Either `unfurls` or `metadata` must be provided.",
         "type": "string"
       },
       "user_auth_message": {
@@ -85,6 +82,17 @@
           "composer",
           "conversations_history"
         ]
+      },
+      "metadata": {
+        "desc": "JSON object with `entity_type` and `entity_payload` fields, presented as a URL-encoded string. Either `unfurls` or `metadata` must be provided.",
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
       }
     }
   },
@@ -140,6 +148,9 @@
     },
     "missing_unfurls": {
       "desc": "The request is missing the `unfurls` parameter."
+    },
+    "error_processing_metadata": {
+      "desc": "The metadata parameter was invalid."
     }
   },
   "examples": {

docs.slack.dev/methods/entity.presentDetails.json

@@ -0,0 +1,94 @@
+{
+  "desc": "Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.",
+  "http_method": "POST",
+  "scope": "none",
+  "rate_limits": "t3",
+  "json_input_supported": true,
+  "slack_connect_workspaces_allowed": true,
+  "args": {
+    "type": "object",
+    "required": [
+      "token",
+      "trigger_id"
+    ],
+    "properties": {
+      "token": {
+        "type": "string",
+        "subtype": "auth",
+        "org_app": {
+          "allowed": true,
+          "derive_team_context_from": "token"
+        },
+        "example": "xxxx-xxxxxxxxx-xxxx"
+      },
+      "metadata": {
+        "desc": "URL-encoded JSON object containing flexpane metadata from the app that will be conformed to a Work Object metadata schema, keyed by entity ID.",
+        "type": "object"
+      },
+      "trigger_id": {
+        "type": "string",
+        "desc": "A reference to the original user action that initiated the request."
+      },
+      "user_auth_required": {
+        "default": "0",
+        "desc": "Set to true (or 1) to indicate that the user must authenticate to view full flexpane data.",
+        "type": "boolean"
+      },
+      "user_auth_url": {
+        "desc": "A custom URL to which users are directed for authentication if required.",
+        "example": "https://example.com/onboarding?user_id=xxx",
+        "type": "string"
+      },
+      "error": {
+        "schema": "error"
+      }
+    }
+  },
+  "output": null,
+  "errors": {
+    "invalid_metadata": {
+      "desc": "The provided `metadata` argument could not be parsed or understood."
+    },
+    "feature_not_enabled": {
+      "desc": "temporarily gating API"
+    },
+    "invalid_app_id": {
+      "desc": "App ID is not a valid format"
+    },
+    "user_auth_url_missing": {
+      "desc": "User auth url is required if user_auth_required is true"
+    },
+    "invalid_trigger_id": {
+      "desc": "Trigger id is not valid"
+    },
+    "entity_metadata_does_not_match_trigger": {
+      "desc": "The provided entity's ID does not match the ID of the entity used to initiate the request"
+    },
+    "missing_interactivity_url": {
+      "desc": "App does not have an interactivity URL configured"
+    },
+    "missing_options_load_url": {
+      "desc": "App does not have an options load URL configured"
+    },
+    "invalid_auth": {
+      "desc": "Invalid token provided"
+    }
+  },
+  "examples": {
+    "success": {
+      "url": "/api/entity.presentDetails?token=YOUR_TOKEN",
+      "description": "Typical success response",
+      "example": {
+        "ok": true
+      }
+    },
+    "error": {
+      "url": "/api/entity.presentDetails?token=INVALID_TOKEN",
+      "description": "Typical error response",
+      "example": {
+        "ok": false,
+        "error": "invalid_auth"
+      }
+    }
+  }
+}

docs.slack.dev/methods/methods.json

@@ -1371,6 +1371,13 @@
       "emoji"
     ]
   },
+  {
+    "name": "entity.presentDetails",
+    "description": "Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.",
+    "family": [
+      "entity"
+    ]
+  },
   {
     "name": "files.comments.delete",
     "description": "Deletes an existing comment on a file.",

events/entity_details_requested.json

@@ -0,0 +1,8 @@
+{
+  "name": "entity_details_requested",
+  "desc": "This event is sent to your app when a user clicks on a Work Object unfurl or refreshes the flexpane.",
+  "scopes": [],
+  "APIs": [
+    "Events"
+  ]
+}

groups/entity.json

@@ -0,0 +1,3 @@
+{
+  "name": "entity"
+}

methods/chat/chat.unfurl.json

@@ -5,18 +5,18 @@
   "desc": "Provide custom unfurl behavior for user-posted URLs",
   "args": {
     "channel": {
-      "required": true,
+      "required": false,
       "desc": "Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together.",
       "type": "channel"
     },
     "ts": {
-      "required": true,
+      "required": false,
       "desc": "Timestamp of the message to add unfurl behavior to.",
       "type": "timestamp"
     },
     "unfurls": {
-      "required": true,
-      "desc": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.",
+      "required": false,
+      "desc": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. Either unfurls or metadata must be provided.",
       "type": "string",
       "format": "json"
     },
@@ -53,6 +53,12 @@
       "example": "composer",
       "desc": "The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation.",
       "type": "enum"
+    },
+    "metadata": {
+      "required": false,
+      "desc": "JSON object with entity_type and entity_payload fields, presented as a URL-encoded string. Either unfurls or metadata must be provided.",
+      "type": "string",
+      "format": "json"
     }
   },
   "response": {
@@ -76,6 +82,7 @@
     "deprecated_endpoint": "The endpoint has been deprecated.",
     "ekm_access_denied": "Administrators have suspended the ability to post a message.",
     "enterprise_is_restricted": "The method cannot be called from an Enterprise.",
+    "error_processing_metadata": "The metadata parameter was invalid.",
     "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
     "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
     "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",

methods/entity/entity.presentDetails.json

@@ -0,0 +1,80 @@
+{
+  "group": "entity",
+  "name": "entity.presentDetails",
+  "deprecated": false,
+  "desc": "Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.",
+  "args": {
+    "metadata": {
+      "required": false,
+      "desc": "URL-encoded JSON object containing flexpane metadata from the app that will be conformed to a Work Object metadata schema, keyed by entity ID.",
+      "type": "object",
+      "format": "json"
+    },
+    "trigger_id": {
+      "required": true,
+      "desc": "A reference to the original user action that initiated the request.",
+      "type": "string"
+    },
+    "user_auth_required": {
+      "required": false,
+      "example": "0",
+      "desc": "Set to true (or 1) to indicate that the user must authenticate to view full flexpane data.",
+      "type": "boolean"
+    },
+    "user_auth_url": {
+      "required": false,
+      "example": "https://example.com/onboarding?user_id=xxx",
+      "desc": "A custom URL to which users are directed for authentication if required.",
+      "type": "string"
+    },
+    "error": {
+      "required": false,
+      "desc": ""
+    }
+  },
+  "response": {
+    "examples": [
+      "{\n    \"ok\": true\n}",
+      "{\n    \"ok\": false,\n    \"error\": \"invalid_auth\"\n}"
+    ]
+  },
+  "errors": {
+    "access_denied": "Access to a resource specified in the request is denied.",
+    "accesslimited": "Access to this method is limited on the current network.",
+    "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
+    "deprecated_endpoint": "The endpoint has been deprecated.",
+    "ekm_access_denied": "Administrators have suspended the ability to post a message.",
+    "enterprise_is_restricted": "The method cannot be called from an Enterprise.",
+    "entity_metadata_does_not_match_trigger": "The provided entity's ID does not match the ID of the entity used to initiate the request",
+    "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
+    "feature_not_enabled": "temporarily gating API",
+    "invalid_app_id": "App ID is not a valid format",
+    "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
+    "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
+    "invalid_auth": "Invalid token provided",
+    "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.",
+    "invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.",
+    "invalid_metadata": "The provided `metadata` argument could not be parsed or understood.",
+    "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.",
+    "invalid_trigger_id": "Trigger id is not valid",
+    "is_bot": "This method cannot be called by a legacy bot.",
+    "method_deprecated": "The method has been deprecated.",
+    "missing_interactivity_url": "App does not have an interactivity URL configured",
+    "missing_options_load_url": "App does not have an options load URL configured",
+    "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.",
+    "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
+    "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
+    "not_allowed_token_type": "The token type used in this request is not allowed.",
+    "not_authed": "No authentication token provided.",
+    "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
+    "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
+    "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
+    "service_unavailable": "The service is temporarily unavailable.",
+    "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.",
+    "token_expired": "Authentication token has expired.",
+    "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
+    "two_factor_setup_required": "Two factor setup is required.",
+    "unknown_method": "This method is currently not available.",
+    "user_auth_url_missing": "User auth url is required if user_auth_required is true"
+  }
+}