Agents Channels
API endpoints for Agents Channels
GET
/api/agents/{agent_id}/channels List returns agent channels (Slack integration).
Returns the agent's configured channels and available Slack integrations that can be assigned.
Response Codes
| Status Code | Description |
|---|---|
| 200 | Success |
| 404 | Resource not found |
POST
/api/agents/{agent_id}/channels Create creates a new channel.
Creates a channel binding between an agent and an integration (e.g., Slack). Returns 201 on success.
Request Body request.Channel
Channel
| Property | Type | Description |
|---|---|---|
| channel_integration_id* | integer (int64) | ID of the workspace's channel integration (e.g., Slack workspace integration) |
| channel_config | object | Channel-specific configuration (type, name, default_channel, mention_only) |
| capabilities | string | Supported capabilities (receive_messages, send_messages) |
| is_enabled | boolean | null | Whether the channel is enabled (defaults to true) |
Response Codes
| Status Code | Description |
|---|---|
| 201 | Resource created successfully |
| 404 | Resource not found |
| 422 | Validation failed |
| 500 | Internal server error |
Resource created successfully
Response response.ChannelResponse
Channel
| Property | Type | Description |
|---|---|---|
| id | integer (int64) | Unique channel identifier |
| agent_id | integer (int64) | ID of agent this channel belongs to |
| channel_integration_id | integer (int64) | null | ID of workspace's channel integration |
| channel_config | object | Channel-specific configuration |
| channel_health | object | Channel health check results |
| capabilities | string | Supported capabilities (receive_messages, send_messages) |
| is_enabled | boolean | Whether channel is enabled |
| is_ready | boolean | Whether channel is ready to use (enabled + healthy + has integration) |
| created_at | string (date-time) | Timestamp when channel was created |
| updated_at | string (date-time) | Timestamp when channel was last updated |
| integration | string | null | Integration summary (if loaded) |
PATCH
/api/agents/{agent_id}/channels/{channel_id} Update updates a channel.
Updates the channel's configuration, capabilities, or enabled status. Returns 403 if the channel does not belong to the agent.
Request Body request.ChannelUpdate
Channel Update
| Property | Type | Description |
|---|---|---|
| channel_config | object | Channel-specific configuration (type, name, default_channel, mention_only) |
| capabilities | string | Supported capabilities (receive_messages, send_messages) |
| is_enabled | boolean | null | Whether the channel is enabled |
Response Codes
| Status Code | Description |
|---|---|
| 200 | Success |
| 400 | Invalid request |
| 403 | Permission denied |
| 404 | Resource not found |
| 422 | Validation failed |
| 500 | Internal server error |
Success
Response response.ChannelResponse
Channel
| Property | Type | Description |
|---|---|---|
| id | integer (int64) | Unique channel identifier |
| agent_id | integer (int64) | ID of agent this channel belongs to |
| channel_integration_id | integer (int64) | null | ID of workspace's channel integration |
| channel_config | object | Channel-specific configuration |
| channel_health | object | Channel health check results |
| capabilities | string | Supported capabilities (receive_messages, send_messages) |
| is_enabled | boolean | Whether channel is enabled |
| is_ready | boolean | Whether channel is ready to use (enabled + healthy + has integration) |
| created_at | string (date-time) | Timestamp when channel was created |
| updated_at | string (date-time) | Timestamp when channel was last updated |
| integration | string | null | Integration summary (if loaded) |
DELETE
/api/agents/{agent_id}/channels/{channel_id} Remove deletes a channel.
Removes the channel binding from the agent. Returns 403 if the channel does not belong to the agent.
Response Codes
| Status Code | Description |
|---|---|
| 204 | Success with no content |
| 400 | Invalid request |
| 403 | Permission denied |
| 404 | Resource not found |
| 500 | Internal server error |