Slack.Web.Admin.Apps.Config (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Look up the app config for connectors by their IDs

Set the app config for a connector

Functions

lookup(optional_params \\ %{})

Look up the app config for connectors by their IDs

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Optional Params

  • app_ids - An array of app IDs to get app configs for ex: A0A2R51A5,A0A2R51A6
  • rich_link_preview_types - return apps with the corresponding rich link preview layouts ex: limited_details, no_preview

Errors the API can return:

  • missing_args - Either app_ids or rich_link_preview_types must be provided

See the Common Errors guide for errors returned by every Web API method.

set(app_id, optional_params \\ %{})

Set the app config for a connector

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

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: urls and emails. 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 of builder_choice or end_user_only. Acceptable values: builder_choice end_user_only

Errors the API can return:

  • invalid_app - App is invalid
  • invalid_domains - At least one URL or email is invalid
  • invalid_workflow_auth_strategy - workflow auth strategy is invalid
  • no_domains_provided - At least one allowed domain must be specified if populating the argument
  • restricted_plan_level - The given parameter is not supported on this team.
  • too_many_domains_provided - Too many domains provided. Please provide 50 or less for each type of domain
  • unknown_method - This method does not exist.
  • url_restriction_not_supported - URL restriction is not supported for this app.

See the Common Errors guide for errors returned by every Web API method.