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 notification channel

post

Create notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
typestring · enumRequiredDefault: emailPossible values:
Responses
200

Notification channel 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: 150

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

Get notification channel

get

Get notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Responses
200

Notification channel

application/json
typestring · enumRequiredDefault: emailPossible values:
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 notification channel

put

Update notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Body
typestring · enumRequiredDefault: emailPossible values:
Responses
200

Notification channel 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: 150

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

Delete notification channel

delete

Delete notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Responses
204

Notification channel 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 notification channel

patch

Patch notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
namestring · min: 1 · max: 250Required

Notification Channel name

Body
typestring · enumOptionalDefault: emailPossible values:
Responses
200

Notification channel 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:
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
NextSlack

Last updated