Packages

A Slack Web & Real Time Messaging API client.

Retired package: Renamed - 1.0.0-alpha.0

Current section

Files

Jump to
slack_kit lib slack web docs entity.presentDetails.json
Raw

lib/slack/web/docs/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": {
"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",
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
"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_arguments": "The method was called with invalid arguments.",
"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",
"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_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"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.",
"user_auth_url_missing": "User auth url is required if user\\_auth\\_required is true"
}
}