Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cake.ai/llms.txt

Use this file to discover all available pages before exploring further.

Cake Agents drives sessions from Slack through a single Events API endpoint: 
POST {BASE_PATH}/api/slack/event
Use the scripts/setup-slack helper to generate an app manifest pre-filled with the right URLs, install the app to your workspace, and persist the resulting secrets.

​
Prerequisites

  • A running Cake Agents deployment reachable from Slack (a public origin, or the dev origin derived from ISTIO_HOST_DOMAIN).
  • Permission to create Slack apps in your workspace.

​
Run the setup script

From the repository root: 
scripts/setup-slack
For all flags and defaults: 
scripts/setup-slack -h

​
Common options

FlagDefaultDescription
--originCAKE_AGENTS_ORIGIN, or https://<hostname-prefix>.$ISTIO_HOST_DOMAIN when ISTIO_HOST_DOMAIN is setPublic origin Slack will call.
--base-pathBASE_PATH (or empty)Path prefix in front of the API.
--formaturlEmit the manifest as a Slack-app-create link (url) or raw json.

​
What it does

  1. Prints a Slack app creation link that embeds an App Manifest as URL-encoded JSON.
  2. Prompts for SLACK_SIGNING_SECRET first.
  3. After you install the app to your workspace, prompts for SLACK_BOT_TOKEN.
  4. Writes (or updates) ./.slack-creds (a gitignored file) with both secrets.
The .slack-creds file is local-only and gitignored. For production deployments, supply the same values through your secret manager and the Helm chart’s Slack secret template. See Configure Slack credentials.

​
Example

Generate a manifest URL for a custom origin and base path: 
scripts/setup-slack \
  --origin https://agents.example.com \
  --base-path /cake \
  --format url
Open the printed link, create the app in Slack, install it to your workspace, then return to the prompt and paste your signing secret and bot token when asked.

​
Verify the integration

After credentials are saved and the server restarts:
  1. Invite the bot to a channel.
  2. Mention it (@your-bot help) or open a direct message to trigger app_mention / message / assistant_thread_started events.
  3. Confirm sessions appear in the Cake Agents UI at http://localhost:4000 (or your deployed origin).