Sign in
latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

slack

Finish a Slack installation

Completes the installation flow for the Slack integration. This endpoint is typically called after the user has completed any required authorization steps with Slack.

post/integrations/slack/installations/finish

Request body

app_idstring required

The app ID of the Slack app that was originally configured at the project-level.

codestring required

The code that was returned from the OAuth flow, and found in the query string of the redirect URL.

redirect_urlstring

Example request

{
  "app_id": "12345678901",
  "code": "string",
  "redirect_url": "string"
}

Response

Created

access_tokenstring required

Bot token returned from the Slack OAuth exchange.

app_idstring required

Slack app identifier for the installed app.

bot_user_idstring

Slack user ID of the installed bot.

expires_ininteger

Seconds until the bot access token expires.

idstring

Unique identifier MagicBell assigns to the Slack installation.

is_enterprise_installboolean

Indicates whether the installation occurred on an enterprise grid.

refresh_tokenstring

Refresh token for regenerating the bot access token.

scopestring

Space-delimited OAuth scopes granted to the bot token.

token_typestring

Type of bot token returned by Slack.

Example response

{
  "access_token": "xoxb-123456789012-1234567890123-12345678901234567890abcdef123456",
  "app_id": "A12345678",
  "authed_user": {
    "id": "U12345678",
    "scope": "identify,commands"
  },
  "bot_user_id": "U12345678",
  "enterprise_id": "E12345678",
  "enterprise_name": "Enterprise Grid, Inc.",
  "id": "A12345678-T123",
  "incoming_webhook": {
    "channel": "C12345678",
    "channel_id": "C12345678",
    "configuration_url": "https://teamname.slack.com/services/B12345678",
    "url": "https://hooks.slack.com/services/T12345678/B12345678/123456789012345678901234"
  },
  "scope": "identify,commands,bot",
  "team": {
    "id": "T123",
    "name": "Team Installing Your App"
  },
  "team_id": "T12345678",
  "team_name": "Team Installing Your App"
}