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

View Source

Summary

Functions

Create an app from an app manifest.

Permanently deletes an app created through app manifests

Export an app manifest from an existing app

Update an app from an app manifest

Functions

create(manifest, optional_params \\ %{})

Create an app from an app manifest.

API reference

Rate limit: Tier 1: 1+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • manifest - A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one.

Optional Params

  • team_id - When called with an org token, which specific team to create app on

Errors the API can return:

  • dynamic_client_registration_failed - Dynamic client registration failed for an MCP server that requires OAuth authentication.
  • dynamic_client_registration_invalid_redirect_uri - The remote server rejected Slack's redirect URI during Dynamic Client Registration. The server must allowlist https://oauth2.slack.com/external/auth/callback as a valid redirect URI.
  • dynamic_client_registration_invalid_response - The MCP server returned an invalid response during Dynamic Client Registration.
  • dynamic_client_registration_missing_oauth_endpoints - The MCP server's OAuth metadata is missing a required authorization or token endpoint.
  • dynamic_client_registration_not_supported - The MCP server's OAuth metadata does not include a registration endpoint. The server may not support Dynamic Client Registration.
  • dynamic_client_registration_rejected - The MCP server rejected the Dynamic Client Registration request.
  • failed_adding_collaborator - Failed writing a collaborator record for this new app
  • failed_creating_app - Failed to create the app model
  • failed_datastore_operation - Failed while managing datastore infrastructure
  • failed_generating_app_token - App level token failed to generate.
  • invalid_app - An app created from the provided manifest would not be valid.
  • invalid_manifest - The provided manifest file does not validate against schema. Consult the additional errors field to locate specific issues.
  • invalid_team_id - The provided team ID is not valid
  • managed_app_limit_reached - The manager app has reached the maximum number of managed apps it can create.
  • not_in_team - Cannot create an app in a team that user is not a member of
  • oauth_metadata_not_found - Could not discover OAuth metadata for the MCP server. Ensure the server exposes a .well-known/oauth-authorization-server or .well-known/openid-configuration endpoint.
  • socket_mode_not_enabled - Socket mode is not enabled in manifest.
  • unknown_method - Unknown method

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

delete(app_id, optional_params \\ %{})

Permanently deletes an app created through app manifests

API reference

Rate limit: Tier 1: 1+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • app_id - The ID of the app you want to delete.

Errors the API can return:

  • app_not_eligible - The specified app is not elgible for this API.
  • app_not_found - The specified app was not found.
  • app_not_owned_by_manager_app - The app is not owned by the manager app.
  • invalid_app_id - The app ID passed in was invalid.
  • published_app_only - This action is only permitted for published app IDs.

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

export(app_id, optional_params \\ %{})

Export an app manifest from an existing app

API reference

Rate limit: Tier 3: 50+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • app_id - The ID of the app whose configuration you want to export as a manifest.

Errors the API can return:

  • app_not_eligible - The specified app is not elgible for this API.
  • app_not_found - The specified app was not found.
  • app_not_owned_by_manager_app - The app is not owned by the manager app.
  • failed_export - Failed to export manifest for given app ID
  • invalid_app_id - The app ID passed is invalid.
  • unknown_method - This method does not exist.

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

update(app_id, manifest, optional_params \\ %{})

Update an app from an app manifest

API reference

Rate limit: Tier 1: 1+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • app_id - The ID of the app whose configuration you want to update.
  • manifest - A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one. As this method entirely replaces any previous configuration, manifest must contain both unmodified and modified fields.

Errors the API can return:

  • app_not_eligible - The specified app is not eligible for this API.
  • app_not_owned_by_manager_app - The specified app is not managed by the calling manager app.
  • dynamic_client_registration_failed - Dynamic client registration failed for an MCP server that requires OAuth authentication.
  • dynamic_client_registration_invalid_redirect_uri - The remote server rejected Slack's redirect URI during Dynamic Client Registration. The server must allowlist https://oauth2.slack.com/external/auth/callback as a valid redirect URI.
  • dynamic_client_registration_invalid_response - The MCP server returned an invalid response during Dynamic Client Registration.
  • dynamic_client_registration_missing_oauth_endpoints - The MCP server's OAuth metadata is missing a required authorization or token endpoint.
  • dynamic_client_registration_not_supported - The MCP server's OAuth metadata does not include a registration endpoint. The server may not support Dynamic Client Registration.
  • dynamic_client_registration_rejected - The MCP server rejected the Dynamic Client Registration request.
  • failed_adding_collaborator - Failed writing a collaborator record for this new app
  • failed_creating_app - Failed to create the app model
  • failed_datastore_operation - Failed while managing datastore infrastructure
  • invalid_app - An app created from the provided manifest would not be valid.
  • invalid_app_id - The app id passed is invalid.
  • invalid_manifest - The provided manifest file does not validate against schema.
  • oauth_metadata_not_found - Could not discover OAuth metadata for the MCP server. Ensure the server exposes a .well-known/oauth-authorization-server or .well-known/openid-configuration endpoint.
  • unknown_method - Unknown method

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

validate(manifest, optional_params \\ %{})

Validate an app manifest

API reference

Rate limit: Tier 3: 50+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • manifest - The manifest to be validated. Will be validated against the app manifest schema - read our guide.

Optional Params

  • app_id - The ID of the app whose configuration you want to validate.

Errors the API can return:

  • app_not_eligible - The specified app is not eligible for this API.
  • app_not_owned_by_manager_app - The app is not owned by the manager app.
  • failed_adding_collaborator - Failed writing a collaborator record for this new app
  • failed_creating_app - Failed to create the app model
  • invalid_app - An app created from the provided manifest would not be valid.
  • invalid_app_id - The app id passed is invalid.
  • invalid_manifest - The provided manifest file does not validate against schema.
  • unknown_method - Unknown method

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