Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ You can talk to an Inkeep Agent in a few ways, including:
- **Via API (Vercel format)**: An API that streams responses over server-side events (SSE). Use from any language/runtime, including the Vercel's `useChat` and AI Element primitives for custom UIs. See [API (Vercel format)](/talk-to-your-agents/api).
- **Via API (A2A format)**: An API that follows the Agent-to-Agent ('A2A') JSON-RPC protocol. Great for when combining Inkeep with different Agent frameworks that support the A2A format. See [A2A protocol](/talk-to-your-agents/a2a).
- **Via Webhook Triggers**: Create webhook endpoints that allow external services (GitHub, Slack, Stripe, etc.) to invoke your Agents. See [Triggers](/talk-to-your-agents/triggers).
- **Work Apps**: Real-time integrations with collaboration platforms like Slack. Use slash commands and @mentions for interactive conversations. See [Work Apps](/talk-to-your-agents/work-apps/slack).

<Cards>
<Card title="React UI" icon="LuMessageSquare" href="/talk-to-your-agents/react/chat-button">
Expand All @@ -22,6 +23,9 @@ You can talk to an Inkeep Agent in a few ways, including:
<Card title="Webhook Triggers" icon="LuWebhook" href="/talk-to-your-agents/triggers">
Webhook endpoints for event-driven Agent invocation.
</Card>
<Card title="Work Apps" icon="LuPlug" href="/talk-to-your-agents/work-apps/slack">
Real-time Slack integration with slash commands and @mentions.
</Card>
</Cards>


Expand Down
18 changes: 18 additions & 0 deletions agents-docs/content/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,24 @@ Sub Agents in Inkeep are designed to respond to the user as a single, cohesive u

<Snippet file="multi-agent-framework/WaysToTalkToAgent.mdx" />

## Work Apps

**Work Apps** are platform integrations that let your Agents operate directly inside collaboration tools like Slack. Unlike webhook triggers that respond to events, Work Apps provide real-time, interactive experiences with features like:

- **Slash commands** - Users invoke Agents with commands like `/inkeep [question]`
- **@mentions** - Tag the Agent in channels for public, threaded responses
- **User account linking** - Connect Slack users to their Inkeep identity for personalized responses
- **Workspace configuration** - Set default Agents per workspace or channel

Work Apps are installed at the workspace level via OAuth and configured through the dashboard.

<Cards>
<Card title="Slack Integration" icon="brand/Slack" href="/talk-to-your-agents/work-apps/slack">
Connect your Agents to Slack for real-time conversations.
</Card>
</Cards>


## Triggers

**Triggers** are webhook endpoints that allow external services to invoke your Agents. When a webhook is received, the payload is validated, transformed into a message, and used to start a new conversation.
Expand Down
85 changes: 85 additions & 0 deletions agents-docs/content/talk-to-your-agents/(work-apps)/slack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: Slack Integration
sidebarTitle: Slack
description: Connect your Inkeep Agents to Slack for real-time conversations via slash commands and @mentions.
icon: brand/Slack
---

Enable your team to interact with Inkeep Agents directly from Slack using slash commands and @mentions.

## Features

- **Slash commands** - `/inkeep [question]` for private, ephemeral responses
- **@mentions** - `@Inkeep [question]` for public, threaded responses
- **Multi-turn conversations** - Continue conversations with the Follow Up button
- **Agent configuration** - Set default agents per workspace or channel
- **Account linking** - Connect Slack identities to Inkeep for personalized responses

## Setup

<Steps>
<Step>
### Install the Slack app

Navigate to **Work Apps → Slack** in the dashboard and click **Install to Slack**. Complete the OAuth flow to authorize the app in your workspace.
</Step>
<Step>
### Configure the default agent

After installation, select a default agent for your workspace. This agent handles all requests unless overridden at the channel level.
</Step>
<Step>
### Link user accounts (optional)

Users can link their Slack account to Inkeep by running `/inkeep link` in Slack and clicking the generated link. This enables personalized responses.
</Step>
</Steps>

## Slash commands

| Command | Description |
|---------|-------------|
| `/inkeep [question]` | Ask the default agent (ephemeral response) |
| `/inkeep` | Open the agent picker modal |
| `/inkeep help` | Show available commands |
| `/inkeep link` | Link your Slack account to Inkeep |
| `/inkeep status` | Check your link status and active agent |
| `/inkeep run "agent" [question]` | Ask a specific agent by name |

Slash command responses are **ephemeral** - only visible to you.

## @Mentions

Mention `@Inkeep` in any channel to get a public response in a thread:

```
@Inkeep How do I configure authentication?
```

The response streams in real-time and is visible to everyone in the channel. Reply in the thread to continue the conversation.

## Agent configuration

### Workspace default

Set a default agent for the entire workspace in the dashboard. This agent handles all requests unless a channel-specific default is configured.

### Channel defaults

Override the workspace default for specific channels. Navigate to **Work Apps → Slack → Channels** in the dashboard to configure channel-level agents.

Agent resolution priority: **Channel default → Workspace default**

## Troubleshooting

<Accordions>
<Accordion title="'User not linked' error">
Run `/inkeep link` in Slack and click the generated link to complete account linking.
</Accordion>
<Accordion title="'No agent configured' error">
An admin needs to set a workspace or channel default agent in the dashboard.
</Accordion>
<Accordion title="'Link token expired' error">
Link tokens expire after 10 minutes. Run `/inkeep link` again to generate a new link.
</Accordion>
</Accordions>
1 change: 1 addition & 0 deletions agents-docs/content/talk-to-your-agents/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"mcp-server",
"chat-api",
"triggers",
"(work-apps)",
"(chat-components)",
"vercel-ai-sdk",
"a2a",
Expand Down
Loading