Current section
Files
Jump to
Current section
Files
priv/docs/methods/entity.presentDetails.json
{
"args": {
"error": {
"desc": "",
"required": false
},
"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.",
"required": false,
"type": "object"
},
"trigger_id": {
"desc": "A reference to the original user action that initiated the request.",
"required": true,
"type": "string"
},
"user_auth_required": {
"default": "0",
"desc": "Set to true (or 1) to indicate that the user must authenticate to view full flexpane data.",
"required": false,
"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",
"required": false,
"type": "string"
}
},
"desc": "Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.",
"errors": {
"entity_metadata_does_not_match_trigger": "The provided entity's ID does not match the ID of the entity used to initiate the request",
"feature_not_enabled": "temporarily gating API",
"invalid_app_id": "App ID is not a valid format",
"invalid_metadata": "The provided `metadata` argument could not be parsed or understood.",
"invalid_trigger_id": "Trigger id is not valid",
"missing_interactivity_url": "App does not have an interactivity URL configured",
"missing_options_load_url": "App does not have an options load URL configured",
"user_auth_url_missing": "User auth url is required if user\\_auth\\_required is true"
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {}
}