Connect a Slack workspace

Operation ID: createSlackWorkspace

Group: Base › Slack Workspaces

Open in the interactive reference

POST /base/slack-workspaces

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Connects a Slack workspace to the tenant, so the Lensing Slack gateway answers its members. The Lensing Slack gateway calls this right after a tenant admin installs the Lensing Slack app from Settings and Policies, with that admin's own token, so only someone allowed to connect workspaces can bind one.

A tenant connects at most one Slack workspace. If teamId is already connected, the request fails with WORKSPACE_ALREADY_CONNECTED, which gives the existing record's id; a caller that only wants the workspace connected can treat that as success. If a different workspace is connected, it fails with ANOTHER_WORKSPACE_CONNECTED, which names that workspace; it has to be uninstalled from Settings and Policies before another one can connect.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createSlackWorkspaceInput.

Field Type Required Description
teamId string yes The Slack team id of the workspace to connect, for example 'T0C4A9X2BRR'. Example: "T0C4A9X2BRR".
teamName string no The display name of the Slack workspace. Example: "Lensingbots Customer Test". 
{
  "teamId": "T0C4A9X2BRR",
  "teamName": "Lensingbots Customer Test"
}

Response

200 Success

Under data (createSlackWorkspaceOutput):

Field Type Required Description
id string yes The unique identifier of the new connection. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
INTEGRATION_DISABLED 400
INVALID_TEAM_ID 400
WORKSPACE_ALREADY_CONNECTED 400
ANOTHER_WORKSPACE_CONNECTED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses