Slack

Install Slack App

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Query Parameters

tenant_id?string

Response Body

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/install"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/install"

Empty

Slack OAuth Callback

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Query Parameters

code?string

error?string

state?string

Response Body

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/oauth_redirect"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/oauth_redirect"

Empty

Create Nango Connect Session

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Request Body

application/json

tenantId?string

Tenant ID

userEmail?string

User email

userId*string

Inkeep user ID

userName?string

User display name

Response Body

`application/json`

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/connect" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "string"
  }'

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/connect" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'

{
  "connectUrl": "string",
  "sessionToken": "string"
}

Empty

Disconnect User

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Request Body

application/json

slackTeamId?string

Slack team ID

slackUserId?string

Slack user ID

tenantId?string

Tenant ID

userId?string

Inkeep user ID

Response Body

`application/json`

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/disconnect" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/disconnect" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true
}

Empty

Check Link Status

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Query Parameters

slackUserId*string

slackTeamId*string

tenantId?string

Default"default"

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/users/link-status?slackUserId=string&slackTeamId=string"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/users/link-status?slackUserId=string&slackTeamId=string"

{
  "linkId": "string",
  "linked": true,
  "linkedAt": "string",
  "slackUsername": "string"
}

Verify Link Token

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Request Body

application/json

token*string

Length1 <= length

userEmail?string

Formatemail

userId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/link/verify-token" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "string",
    "userId": "string"
  }'

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/link/verify-token" \  -H "Content-Type: application/json" \  -d '{    "token": "string",    "userId": "string"  }'

{
  "linkId": "string",
  "slackTeamId": "string",
  "slackUsername": "string",
  "success": true,
  "tenantId": "string"
}

Empty

Get Connection Status

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Query Parameters

userId*string

Inkeep user ID

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/users/status?userId=string"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/users/status?userId=string"

{
  "connected": true,
  "connection": {
    "appUserEmail": "string",
    "appUserId": "string",
    "connectionId": "string",
    "linkedAt": "string",
    "slackDisplayName": "string",
    "slackTeamId": "string",
    "slackUserId": "string",
    "tenantId": "string"
  }
}

Empty

List Workspaces

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces"

{
  "workspaces": [
    {
      "connectionId": "string",
      "defaultAgentName": "string",
      "hasDefaultAgent": true,
      "teamId": "string",
      "teamName": "string",
      "tenantId": "string"
    }
  ]
}

Get Workspace

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId"

{
  "connectionId": "string",
  "defaultAgent": {
    "agentId": "string",
    "agentName": "string",
    "projectId": "string",
    "projectName": "string"
  },
  "teamId": "string",
  "teamName": "string",
  "tenantId": "string"
}

Empty

Uninstall Workspace

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Response Body

`application/json`

curl -X DELETE "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId"

curl -X DELETE "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId"

{
  "success": true
}

Empty

List Channels

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Query Parameters

limit?number

Default100

cursor?string

types?string

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels"

{
  "channels": [
    {
      "agentConfig": {
        "agentId": "string",
        "agentName": "string",
        "projectId": "string",
        "projectName": "string"
      },
      "hasAgentConfig": true,
      "id": "string",
      "isPrivate": true,
      "isShared": true,
      "memberCount": 0,
      "name": "string"
    }
  ],
  "nextCursor": "string"
}

Empty

Get Channel Settings

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

channelId*string

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/:channelId/settings"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/:channelId/settings"

{
  "agentConfig": {
    "agentId": "string",
    "agentName": "string",
    "projectId": "string",
    "projectName": "string"
  },
  "channelId": "string"
}

Remove Channel Config

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

channelId*string

Response Body

`application/json`

curl -X DELETE "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/:channelId/settings"

curl -X DELETE "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/:channelId/settings"

{
  "success": true
}

Set Channel Default Agent

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

channelId*string

Request Body

application/json

agentConfig*

channelName?string

channelType?string

Response Body

`application/json`

curl -X PUT "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/:channelId/settings" \
  -H "Content-Type: application/json" \
  -d '{
    "agentConfig": {
      "agentId": "string",
      "projectId": "string"
    }
  }'

curl -X PUT "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/:channelId/settings" \  -H "Content-Type: application/json" \  -d '{    "agentConfig": {      "agentId": "string",      "projectId": "string"    }  }'

{
  "configId": "string",
  "success": true
}

Bulk Remove Channel Configs

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Request Body

application/json

channelIds*array<>

Items1 <= items

Response Body

`application/json`

curl -X DELETE "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/bulk" \
  -H "Content-Type: application/json" \
  -d '{
    "channelIds": [
      "string"
    ]
  }'

curl -X DELETE "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/bulk" \  -H "Content-Type: application/json" \  -d '{    "channelIds": [      "string"    ]  }'

{
  "removed": 0,
  "success": true
}

Bulk Set Channel Agents

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Request Body

application/json

agentConfig*

channelIds*array<>

Items1 <= items

Response Body

`application/json`

curl -X PUT "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/bulk" \
  -H "Content-Type: application/json" \
  -d '{
    "agentConfig": {
      "agentId": "string",
      "projectId": "string"
    },
    "channelIds": [
      "string"
    ]
  }'

curl -X PUT "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/channels/bulk" \  -H "Content-Type: application/json" \  -d '{    "agentConfig": {      "agentId": "string",      "projectId": "string"    },    "channelIds": [      "string"    ]  }'

{
  "errors": [
    {
      "channelId": "string",
      "error": "string"
    }
  ],
  "failed": 0,
  "success": true,
  "updated": 0
}

Empty

Check Workspace Health

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/health"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/health"

{
  "botId": "string",
  "botName": "string",
  "error": "string",
  "healthy": true,
  "permissions": {
    "canPostMessages": true,
    "canReadChannels": true,
    "canReadHistory": true
  },
  "teamId": "string",
  "teamName": "string"
}

Empty

Get Workspace Settings

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/settings"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/settings"

{
  "defaultAgent": {
    "agentId": "string",
    "agentName": "string",
    "projectId": "string",
    "projectName": "string"
  }
}

Update Workspace Settings

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Request Body

application/json

defaultAgent?

Response Body

`application/json`

curl -X PUT "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/settings" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/settings" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true
}

{
  "success": true
}

Send Test Message

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Request Body

application/json

channelId*string

message?string

Response Body

`application/json`

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/test-message" \
  -H "Content-Type: application/json" \
  -d '{
    "channelId": "string"
  }'

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/test-message" \  -H "Content-Type: application/json" \  -d '{    "channelId": "string"  }'

{
  "error": "string",
  "messageTs": "string",
  "success": true
}

Empty

List Linked Users

Authorization

bearerAuth cookieAuth

AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

In: cookie

Path Parameters

teamId*string

Response Body

`application/json`

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/users"

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/users"

{
  "linkedUsers": [
    {
      "id": "string",
      "lastUsedAt": "string",
      "linkedAt": "string",
      "slackEmail": "string",
      "slackTeamId": "string",
      "slackUserId": "string",
      "slackUsername": "string",
      "userId": "string"
    }
  ]
}

302

302

200application/json

400

500

200application/json

400

404

500

200application/json

200application/json

400

409

200application/json

400

500

200application/json

200application/json

404

200application/json

400

404

500

200application/json

404

200application/json

200application/json

200application/json

200application/json

200application/json

400

404

200application/json

404

200application/json

200application/json

500application/json

200application/json

400

404

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`