Endpoints

Workspaces

Copy page

Operations for managing Slack workspaces

List Workspaces

GET
/work-apps/slack/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>

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

Response Body

application/json

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

GET
/work-apps/slack/workspaces/:teamId

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

Path Parameters

teamId*string

Response Body

application/json

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

DELETE
/work-apps/slack/workspaces/:teamId

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

Path Parameters

teamId*string

Response Body

application/json

curl -X DELETE "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId"
{
  "success": true
}
Empty
Empty
Empty

Check Workspace Health

GET
/work-apps/slack/workspaces/:teamId/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>

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

Path Parameters

teamId*string

Response Body

application/json

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

GET
/work-apps/slack/workspaces/:teamId/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>

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

Path Parameters

teamId*string

Response Body

application/json

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

PUT
/work-apps/slack/workspaces/:teamId/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>

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

Path Parameters

teamId*string

Request Body

application/json

defaultAgent?

Response Body

application/json

application/json

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

POST
/work-apps/slack/workspaces/:teamId/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>

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

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"  }'
{
  "error": "string",
  "messageTs": "string",
  "success": true
}
Empty
Empty