Connect an agent to a Slack workspace - Veryfront

createChannel(projectReference: ID!, input: CreateChannelInput!): Channel!

Requires project.channels.write.

Arguments

Argument	Type	Required	Description
`projectReference`	`ID!`	Yes	Project ID or slug. Requires a person’s credential; agent, run, and service-account callers are forbidden.
`input`	`CreateChannelInput!`	Yes

Input fields

input

CreateChannelInput

Field	Type	Required	Description
`platform`	`ChannelPlatform!`	Yes	Platform connected through the caller’s Slack connection; Slack must already be connected.
`name`	`String`	No	Display name, 1-255 characters.
`agentId`	`String!`	Yes	An agent returned by channelAgents for the same runtime target.
`respondTo`	`ChannelRespondTo`	No	Default mentions.
`allowedSlackChannelIds`	`[String!]`	No	Slack channel IDs. Overlap with another channel in the same workspace is rejected with resource-already-exists. At most 250 IDs; empty means every Slack channel the bot is in. A preview_branch target needs at least one.
`welcomeMessage`	`String`	No	At most 4000 characters; null clears.
`errorMessage`	`String`	No	At most 4000 characters; null clears.
`maxResponseTokens`	`Int`	No	1-65536; null clears.
`runtimeTargetKind`	`RuntimeTargetKind`	No	Default main_branch.
`targetEnvironmentId`	`ID`	No	Required when runtimeTargetKind is environment.
`targetBranchId`	`ID`	No	Required when runtimeTargetKind is preview_branch.

Response

Returns Channel!. Open the type for its fields and nested types.

Field	Type	Description
`id`	`ID!`
`projectId`	`ID!`
`platform`	`ChannelPlatform!`
`name`	`String`
`agentId`	`String`	Project agent that answers in this channel.
`enabled`	`Boolean!`	Always true today; kept for forward compatibility.
`status`	`ChannelStatus!`
`installationId`	`ID`

All fields of Channel. Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation CreateChannel($projectReference: ID!, $input: CreateChannelInput!) {
  createChannel(projectReference: $projectReference, input: $input) {
    id
    projectId
    agentId
    name
    status
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "input": {
    "platform": "slack",
    "agentId": "agent-example"
  }
}