Version 2.21 has reached end of support. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

NotificationChannels

Notification Channels are the medium through which notifications are sent.

Get supported Notification Channels

get

Get supported Notification Channels

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Notification Channel types

application/json
namestringRequired
typestring · enumRequiredDefault: emailPossible values:
get/api/v1/notification-channels
GET /api/v1/notification-channels HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "my-email",
    "type": "email"
  }
]

Create configuration of notification channel

post

Create configuration of notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
typestring · enumRequiredDefault: emailPossible values:
configone ofRequired
namestringRequired
Responses
200

Notification Channel config created

No content
post/api/v1/notification-channels
POST /api/v1/notification-channels HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "type": "email",
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  },
  "name": "text"
}
No content

Create Slack app

post

Create Slack app

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
accessTokenstringRequired

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: 194

{
  "accessToken": "xoxe.xoxp-1-Mi0yLTMzOTYzNjA4MjgxOS04MDI4MzM3NjUzNzQ2LTgyMDIzNzM1NTM5OTEtODMxNjcyNDM2MjY1OS03MjA4NmUzZGIyMTNlNjU5MjVjMDgzZTJmMTk1NWMzOWUwMGEyOGYzN2U1ZWYxYjA1ZjgxY2IzNDA5YThhMTAq"
}
{
  "slackAppUrl": "https://api.slack.com/apps/A089PHD5S0Q"
}

Get configuration of notification channel

get

Get configuration of notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestringRequired

Notification Channel name

Responses
200

Notification channel config

application/json
typestring · enumRequiredDefault: emailPossible values:
configone ofRequired
namestringRequired
get/api/v1/notification-channels/{name}
GET /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "email",
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  },
  "name": "text"
}

Update configuration of Notification Channel

put

Update configuration of Notification Channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestringRequired

Notification Channel name

Body
typestring · enumRequiredDefault: emailPossible values:
configone ofRequired
namestringRequired
Responses
200

Notification Channel config updated

No content
put/api/v1/notification-channels/{name}
PUT /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "type": "email",
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  },
  "name": "text"
}
No content

Delete configuration of Notification Channel

delete

Delete configuration of Notification Channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestringRequired

Notification Channel name

Responses
204

Notification Channel config deleted

No content
delete/api/v1/notification-channels/{name}
DELETE /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Patch configuration of Notification Channel

patch

Patch configuration of Notification Channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestringRequired

Notification Channel name

Body
typestring · enumOptionalDefault: emailPossible values:
configone ofOptional
Responses
200

Notification Channel config patched

No content
patch/api/v1/notification-channels/{name}
PATCH /api/v1/notification-channels/{name} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "type": "email",
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}
No content

Validate configuration of Notification Channel

post

Validate configuration of Notification Channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
typestring · enumRequiredDefault: emailPossible values:
configone ofRequired
Responses
200

Notification Channel validity

application/json
booleanOptionalExample: true
post/api/v1/validate-notification-channel
POST /api/v1/validate-notification-channel HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "type": "email",
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}
true
PreviousNotification Types
NextSubscriptions

Last updated