For the complete documentation index, see llms.txt. This page is also available as Markdown.

Slack

Configure Slack notifications for your organization.

Get slack notification channel

get

Get slack notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Slack notification channel

application/json
get/api/v1/slack
GET /api/v1/slack HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "config": {
    "apiToken": "<your_api_token>"
  }
}

Patch slack notification channel

patch

Patch slack notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
namestringRead-onlyOptional
Responses
200

Slack notification channel patched

application/json
patch/api/v1/slack
PATCH /api/v1/slack HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "config": {
    "recipients": [
      "text"
    ],
    "directNotifications": true
  }
}
200

Slack notification channel patched

{
  "config": {
    "apiToken": "<your_api_token>"
  }
}

Get slack notification state

get

Get slack notification state

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Slack Notifications state

application/json
enabledboolean · nullableOptional
get/api/v1/slack/state
GET /api/v1/slack/state HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "enabled": true
}

Update slack notification state

patch

Update tenant slack notification state

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
enabledboolean · nullableOptional
Responses
200

Slack Notifications state

application/json
enabledboolean · nullableOptional
patch/api/v1/slack/state
PATCH /api/v1/slack/state HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}
{
  "enabled": true
}

Create Slack app

post

Create Slack app

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
accessTokenstring · max: 1000Required

The access token required for creating slack app

Responses
200

Created Slack app response

application/json
slackAppUrlstringRequired
post/api/v1/slack/app
POST /api/v1/slack/app HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "accessToken": "<your_access_token>"
}
{
  "slackAppUrl": "https://api.slack.com/apps/A089PHD5S0Q"
}

Delete Slack app

delete

Delete Slack app

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Deleted Slack app

No content

delete/api/v1/slack/app
DELETE /api/v1/slack/app HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Connect Slack workspace

post

Connect Slack workspace

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Slack OAuth redirect URL

application/json
redirectUrlstring · uriOptionalExample: https://slack.com/oauth/v2/authorize?...
post/api/v1/slack/workspace
POST /api/v1/slack/workspace HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "redirectUrl": "https://slack.com/oauth/v2/authorize?..."
}

Disconnect Slack workspace

delete

Disconnect Slack workspace

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Disconnected Slack workspace

No content

delete/api/v1/slack/workspace
DELETE /api/v1/slack/workspace HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Validate configuration of Slack Channel

post

Validate configuration of Slack Channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
recipientsstring[] · max: 100OptionalDefault: []
directNotificationsboolean · nullableOptional
apiTokenstring · max: 500Optional
Responses
200

Slack Channel validity

application/json
statusbooleanRequired
messagestringOptional
post/api/v1/slack/validate
POST /api/v1/slack/validate HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "apiToken": "<your_api_token>"
}
{
  "status": false,
  "message": "smtp server validation failed"
}
Deprecated

Create Slack app

post

Create Slack app

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
accessTokenstring · max: 1000Required

The access token required for creating slack app

Responses
200

Created Slack app response

application/json
slackAppUrlstringRequired
post/api/v1/notification-channels/slack/create-app
POST /api/v1/notification-channels/slack/create-app HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "accessToken": "<your_access_token>"
}
{
  "slackAppUrl": "https://api.slack.com/apps/A089PHD5S0Q"
}

Last updated