Slack. Web. Admin. Apps. Config
(SlackKit v0.25.0-alpha.0)
View Source
Summary
Functions
Look up the app config for connectors by their IDs
Optional Params
app_ids- An array of app IDs to get app configs for ex:A0A2R51A5,A0A2R51A6rich_link_preview_types- return apps with the corresponding rich link preview layouts ex:limited_details, no_preview
Errors the API can return:
access_denied- Access to a resource specified in the request is denied.accesslimited- Access to this method is limited on the current networkaccount_inactive- Authentication token is for a deleted user or workspace when using abottoken.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.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.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_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- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.invalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.invalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.method_deprecated- The method has been deprecated.missing_args- Either app_ids or rich_link_preview_types must be providedmissing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.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 theRetry-Afterheader for when to retry the request.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.service_unavailable- The service is temporarily unavailableteam_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 expiredtoken_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.two_factor_setup_required- Two factor setup is required.
Set the app config for a connector
Required Params
app_id- The encoded app ID to set the app config for ex:A12345
Optional Params
domain_restrictions- Domain restrictions for the app. Should be an object with two properties:urlsandemails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.rich_link_preview_type- Indicates the app-level override for rich link preview. Unsupported for free teams.
Acceptable values: all_details limited_details no_preview default_to_global_setting
workflow_auth_strategy- The workflow auth permission. Can be one ofbuilder_choiceorend_user_only.
Acceptable values: builder_choice end_user_only
Errors the API can return:
url_restriction_not_supported- URL restriction is not supported for this app.unknown_method- This method does not exist.token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.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.two_factor_setup_required- Two factor setup is required.too_many_domains_provided- Too many domains provided. Please provide 50 or less for each type of domaininvalid_form_data- The method was called via aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.restricted_plan_level- The given parameter is not supported on this team.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.deprecated_endpoint- The endpoint has been deprecated.invalid_workflow_auth_strategy- workflow auth strategy is invalidratelimited- The request has been ratelimited. Refer to theRetry-Afterheader for when to retry the request.no_domains_provided- At least one allowed domain must be specified if populating the argumentekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableinvalid_app- App is invalidteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.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.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.not_authed- No authentication token provided.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.enterprise_is_restricted- The method cannot be called from an Enterprise.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.access_denied- This actor does not have access to the permissions on this resource.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.missing_scope- The token used is not granted the specific scope permissions required to complete this request.missing_post_type- The method was called via aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networktoken_expired- Authentication token has expiredinvalid_domains- At least one URL or email is invalidinvalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.method_deprecated- The method has been deprecated.not_allowed_token_type- The token type used in this request is not allowed.org_login_required- The workspace is undergoing an enterprise migration and will not be available until migration is complete.invalid_auth- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.