---
title: "Start a Slack agent's Slack setup"
method: POST
path: "/api/v1/agent-definitions/{definition_id}/slack-connection"
tags: ["authed"]
---

# Start a Slack agent's Slack setup

`POST /api/v1/agent-definitions/{definition_id}/slack-connection`

## Request

- Base URL: `https://api.teaflask.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.teaflask.com/api/v1/agent-definitions/{definition_id}/slack-connection`
- Auth: none declared

Creates the agent's Slack connection, awaiting its app's credentials;
an agent that already has one keeps it.

## Path parameters

- `definition_id` string, uuid, required: The agent's id, as list_agent_definitions returns it.

## Response `200`

Successful Response

- SlackConnectionResponse
  - `available` boolean, required: Whether this server can connect Slack agents at all.
  - `status` 'awaiting_credentials' | 'awaiting_install' | 'installed' | 'uninstalled' | 'revoked', required
  - `create_app_url` string, nullable, required: The link that creates the agent's Slack app from its manifest.
  - `manifest_json` string, nullable, required: The agent's Slack app manifest, as JSON.
  - `request_urls` SlackRequestUrls, required
    - `events` string, required: Where the Slack app sends its events.
    - `interactivity` string, required: Where the Slack app sends clicks.
    - `oauth_callback` string, required: Where Slack returns after an install.
  - `client_id` string, nullable, required: The Slack app's client ID.
  - `team_name` string, nullable, required: The Slack workspace the app is installed in.
  - `bot_user_id` string, nullable, required: The app's bot user in Slack.
  - `installed_at` string, date-time, nullable, required: When the app was installed in Slack.
  - `signature_trouble` boolean, required: Whether Slack's recent requests failed signature checks.
  - `installed_from_slack` boolean, required: Whether the app was installed from Slack rather than here.

## Other responses

- `401`: Unauthorized
- `403`: The caller may not manage the organization's Slack setup
- `404`: The agent doesn't exist
- `405`: Method not allowed
- `422`: The agent is a website agent, or the request wasn't valid
- `500`: Internal server error
- `503`: Slack isn't set up on this server

## Changes

- **2026-11-03** `c6ac9fd6657f`: 7 info
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `401`
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `403`
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `404`
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `405`
  - …3 more

[Operation history](https://skmtc.dev/teaflask/apis/teaflask-api/changes/api/v1/agent-definitions/:definition_id/slack-connection/post.md)

---

[API](https://skmtc.dev/teaflask/apis/teaflask-api.md) - [All operations](https://skmtc.dev/teaflask/apis/teaflask-api/llms.txt) - [OpenAPI document](https://skmtc.dev/teaflask/apis/teaflask-api/revisions/c6ac9fd6657f?raw)