Skip to main content
POST
Connect an agent to a Slack workspace

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

Body

application/json
platform
enum<string>
required

Messaging platform: slack

Available options:
slack
agent_id
string

Agent ID from listChannelAgents (MCP: list_channel_agents) for the same runtime target; required unless assistant_id is sent

Minimum string length: 1
name
string

Display name, 1-255 characters

Required string length: 1 - 255
assistant_id
string

Deprecated alias of agent_id (CR-channel-field-aliases).

Minimum string length: 1
respond_to
enum<string>

Which Slack messages to answer: mentions, direct_messages or all

Available options:
mentions,
direct_messages,
all
allowed_slack_channel_ids
string[]

Slack channel IDs. Overlap with another channel in the same workspace is rejected with resource-already-exists. IDs come from listSlackChannels (MCP: list_slack_channels); empty means every Slack channel the bot is in. A preview_branch target needs at least one.

Maximum array length: 250
Required string length: 1 - 255
allowed_channels
string[]

Deprecated alias of allowed_slack_channel_ids (CR-channel-field-aliases).

Maximum array length: 250
Required string length: 1 - 255
welcome_message
string | null

Welcome message; null clears

Maximum string length: 4000
error_message
string | null

Message shown when the agent fails; null clears

Maximum string length: 4000
max_response_tokens
integer | null

Maximum response tokens, 1-65536; null clears

Required range: x <= 65536
runtime_target_kind
enum<string>

Runtime target: main_branch, environment or preview_branch

Available options:
main_branch,
environment,
preview_branch
target_environment_id
string<uuid> | null

Environment ID; required when runtime_target_kind is environment

target_branch_id
string<uuid> | null

Branch ID; required when runtime_target_kind is preview_branch

Response

Created channel

id
string<uuid>
required
project_id
string<uuid>
required
binding_id
string<uuid>
required
installation_id
string<uuid> | null
required
platform
enum<string>
required
Available options:
slack
name
string | null
required
agent_id
string | null
required
Minimum string length: 1
assistant_id
string | null
required
Minimum string length: 1
enabled
boolean
required
platform_team_id
string | null
required
platform_bot_id
string | null
required
workspace_name
string | null
required
respond_to
enum<string>
required
Available options:
mentions,
direct_messages,
all
allowed_slack_channel_ids
string[]
required
allowed_channels
string[]
required
status
enum<string>
required
Available options:
connected,
needs_reauth,
error
welcome_message
string | null
required
error_message
string | null
required
max_response_tokens
integer | null
required
runtime_target_kind
enum<string>
required
Available options:
main_branch,
environment,
preview_branch
target_environment_id
string<uuid> | null
required
target_branch_id
string<uuid> | null
required
resolved_target
object
required
created_at
string
required
updated_at
string
required