Skip to content

Commit e687c01

Browse files
authored
Joel/slack doc updates (#1098)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [ ] I have updated the documentation or added new documentation as needed
1 parent 5ba123b commit e687c01

File tree

1 file changed

+48
-23
lines changed

1 file changed

+48
-23
lines changed

docs/integrations/slack.mdx

Lines changed: 48 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,28 @@ sidebarTitle: "Slack"
44
icon: "slack"
55
---
66

7+
Connect Codegen to your Slack workspace to enable seamless communication between agents and your team.
8+
79
<img src="/images/slack.png" />
810

9-
Connect Codegen to your Slack workspace to enable seamless communication between agents and your team.
11+
## Installation
12+
13+
To use this integration, follow the installation and configuration steps below.
14+
15+
<Card
16+
title="Add Codegen to Slack"
17+
icon="slack"
18+
href="https://codegen.com/integrations"
19+
>
20+
Create a Codegen account and visit Integrations > Slack to connect your Slack workspace.
21+
</Card>
22+
23+
<Note>
24+
Configure channel access carefully to ensure agents communicate in the
25+
appropriate places.
26+
</Note>
27+
28+
After installation, proceed to the Configuration Instructions below to finish setup and begin using Codegen in your Slack workspace.
1029

1130
## Capabilities & Functions
1231

@@ -22,39 +41,39 @@ Codegen functions as a full-fledged software engineer that you can interact with
2241

2342
All of these capabilities are accessible through natural language interactions in your Slack workspace, allowing your team to leverage Codegen's assistance without context switching between different platforms.
2443

25-
## Installation
44+
## Configuration Instructions
2645

27-
Add the Codegen app for Slack to your workspace to enable agent communication.
46+
After installing the integration from the Slack Marketplace, configure the bot by inviting it to relevant channels and setting up triggers so Codegen knows when and how to respond.
2847

29-
<Card
30-
title="Add Codegen to Slack"
31-
icon="slack"
32-
href="https://codegen.sh/integrations"
33-
>
34-
Install the Codegen app for Slack from the Slack Marketplace and choose the
35-
channels it can access.
36-
</Card>
48+
### Channel Setup
49+
- **Invite the Codegen bot**: Type `/invite @codegen` in any channel where you want Codegen to participate.
50+
- (Optional) **Create a dedicated channel**: Some Codegen users find creating a channel like `#codegen` helpful for general agent interactions and to encourage experimentation.
3751

38-
<Note>
39-
Configure channel access carefully to ensure agents communicate in the
40-
appropriate places.
41-
</Note>
52+
## What Triggers Slack Messages from Codegen
53+
These triggers kick off new Codegen requests:
54+
- **Direct mentions**: Type `@codegen` followed by your request in any channel where the bot is present.
55+
- **Thread replies**: Tag `@codegen` in threads to continue the conversation.
56+
- **Direct messages**: Send a DM to the Codegen bot for private conversations.
4257

43-
## Message Response Behavior
58+
In addition, Codegen will send messages to Slack when:
59+
- It starts work on a request you made
60+
- It receives an additional message while working on a request
61+
- It completes a task, code change, or research request
4462

45-
Codegen responds to the following messages in Slack:
63+
## How Codegen Responds to Slack Messages
4664

47-
- **Direct Messages:**
65+
Codegen only responds when tagged or messaged directly. Use these approaches to ensure your request reaches it:
4866

49-
- Responds to any DM sent to the Codegen app for Slack
67+
- **Direct Messages:**
68+
- Responds to any DM sent to the Codegen integration for Slack
5069
- Has visibility into previous messages in the conversation (not just threaded replies)
5170
- This provides a more natural conversation experience as many users don't thread messages in DMs
5271

5372
- **Channel Messages:**
54-
- Responds to any message that @mentions Codegen in channels where the app for Slack is installed
73+
- Responds to any message that @mentions Codegen in channels where the integration for Slack is installed
5574
- Only has visibility into the local context of the thread/conversation
56-
- Sending subsequent messages within a thread routes to the same agent
57-
- New messages in an active thread will interrupt the agent if it's currently working
75+
- Sending subsequent messages within a thread routes to the same agent (tag `@codegen` to trigger)
76+
- New messages to `@codegen` in an active thread will interrupt the agent if it's currently working
5877

5978
## Data Privacy and Security
6079

@@ -66,4 +85,10 @@ Codegen responds to the following messages in Slack:
6685

6786
**User Permissions and Access Control:**
6887

69-
Codegen's actions on connected repositories are governed by the permissions of the user who initiated the interaction via Slack. The bot itself does not have independent permissions to repositories. Access to repositories and the ability to trigger actions are determined by the Codegen user's authenticated account and their associated repository permissions. We recommend configuring channel access carefully during installation to ensure the Codegen app for Slack is only present in channels where its use is appropriate.
88+
Codegen's actions on connected repositories are governed by the permissions of the user who initiated the interaction via Slack. The bot itself does not have independent permissions to repositories. Access to repositories and the ability to trigger actions are determined by the Codegen user's authenticated account and their associated repository permissions. We recommend configuring channel access carefully during installation to ensure the Codegen integration for Slack is only present in channels where its use is appropriate.
89+
90+
## Tips for Effective Use
91+
92+
- Use direct language when asking Codegen for help (e.g., "Add pagination to the results view").
93+
- Mention Codegen early in the message so it is triggered promptly.
94+
- Use threads for ongoing conversations with Codegen so it has access to previous context.

0 commit comments

Comments
 (0)