Create Slack Channel Mapping

POST

/org/:org_id/project/:project_id/slack/installations/:installation_id/channel-mappings

POST

/api/v1/org/:org_id/project/:project_id/slack/installations/:installation_id/channel-mappings

$ curl -X POST https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/slack/installations/installation_id/channel-mappings \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "task_agent_id": "019df849-e106-3301-5894-291b4c9c6cab",
>   "channel_id": "C024BE91L",
>   "channel_name": "support-escalations"
> }'

1 {
2   "id": "019a5f0c-4c82-7d25-9f69-5d2e8b3c7f41",
3   "slack_installation_id": "019a5f0c-3b71-7d24-9e58-4c1d7a2b6e30",
4   "channel_id": "C024BE91L",
5   "task_agent_id": "019df849-e106-3301-5894-291b4c9c6cab",
6   "created": "2024-01-16T14:02:18.114905Z",
7   "modified": "2024-01-16T14:02:18.114905Z",
8   "channel_name": "support-escalations"
9 }

Map a Slack channel to a TaskAgent for this installation.

Supply either channel_id or channel_name; naming a channel resolves it to an id against Slack before the mapping is stored, and the response always carries the resolved channel_id. Name matching ignores case and a leading #. task_agent_id must name a TaskAgent in this project. Answers 400 when neither field is given, when the channel name cannot be resolved, when the TaskAgent is not in this project, or when this installation already maps that channel.

Map a Slack channel to a TaskAgent for this installation. Supply either `channel_id` or `channel_name`; naming a channel resolves it to an id against Slack before the mapping is stored, and the response always carries the resolved `channel_id`. Name matching ignores case and a leading `#`. `task_agent_id` must name a TaskAgent in this project. Answers 400 when neither field is given, when the channel name cannot be resolved, when the TaskAgent is not in this project, or when this installation already maps that channel.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"

The organization ID

project_idstringRequiredformat: "uuid"

The project ID

installation_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

task_agent_idstringRequiredformat: "uuid"

TaskAgent assigned to this channel.

channel_idstring or nullOptional<=32 characters

Slack channel ID. If omitted, resolved from channel_name.

channel_namestring or nullOptional<=255 characters

Human-readable Slack channel name. Used to resolve channel_id when not provided.

Response

Slack channel mapping created successfully

idstringformat: "uuid"

Slack channel mapping ID.

slack_installation_idstringformat: "uuid"

Parent Slack installation ID.

channel_idstring

Slack channel ID.

task_agent_idstringformat: "uuid"

TaskAgent assigned to this channel.

createdstring

When the channel mapping was created.

modifiedstring

When the channel mapping was last updated.

channel_namestring or nullOptional

Human-readable Slack channel name.

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error