Vexor

notification

POST/notification.createSlack

notification-createSlack

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildError
Required
boolean

databaseBackup
Required
boolean

vexorpayRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

webhookUrl
Required
string

Minimum length: 1

channel
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.createSlack" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "webhookUrl": "string",
  "channel": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.updateSlack

notification-updateSlack

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildErrorboolean

databaseBackupboolean

vexorpayRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

webhookUrlstring

Minimum length: 1

channelstring

notificationId
Required
string

Minimum length: 1

slackId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.updateSlack" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "webhookUrl": "string",
  "channel": "string",
  "notificationId": "string",
  "slackId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.testSlackConnection

notification-testSlackConnection

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

webhookUrl
Required
string

Minimum length: 1

channel
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.testSlackConnection" \
  -d '{
  "webhookUrl": "string",
  "channel": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.createTelegram

notification-createTelegram

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildError
Required
boolean

databaseBackup
Required
boolean

vexorpayRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

botToken
Required
string

Minimum length: 1

chatId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.createTelegram" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "botToken": "string",
  "chatId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.updateTelegram

notification-updateTelegram

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildErrorboolean

databaseBackupboolean

vexorpayRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

botTokenstring

Minimum length: 1

chatIdstring

Minimum length: 1

notificationId
Required
string

Minimum length: 1

telegramId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.updateTelegram" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "botToken": "string",
  "chatId": "string",
  "notificationId": "string",
  "telegramId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.testTelegramConnection

notification-testTelegramConnection

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

botToken
Required
string

Minimum length: 1

chatId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.testTelegramConnection" \
  -d '{
  "botToken": "string",
  "chatId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.createDiscord

notification-createDiscord

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildError
Required
boolean

databaseBackup
Required
boolean

vexorpayRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

webhookUrl
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.createDiscord" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "webhookUrl": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.updateDiscord

notification-updateDiscord

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildErrorboolean

databaseBackupboolean

vexorpayRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

webhookUrlstring

Minimum length: 1

notificationId
Required
string

Minimum length: 1

discordId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.updateDiscord" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "webhookUrl": "string",
  "notificationId": "string",
  "discordId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.testDiscordConnection

notification-testDiscordConnection

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

webhookUrl
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.testDiscordConnection" \
  -d '{
  "webhookUrl": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.createEmail

notification-createEmail

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildError
Required
boolean

databaseBackup
Required
boolean

vexorpayRestart
Required
boolean

name
Required
string

appDeploy
Required
boolean

dockerCleanup
Required
boolean

smtpServer
Required
string

Minimum length: 1

smtpPort
Required
number

Minimum: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

fromAddress
Required
string

Minimum length: 1

toAddresses
Required
array<string>

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.createEmail" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "smtpServer": "string",
  "smtpPort": 1,
  "username": "string",
  "password": "string",
  "fromAddress": "string",
  "toAddresses": [
    "string"
  ]
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.updateEmail

notification-updateEmail

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

appBuildErrorboolean

databaseBackupboolean

vexorpayRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

smtpServerstring

Minimum length: 1

smtpPortnumber

Minimum: 1

usernamestring

Minimum length: 1

passwordstring

Minimum length: 1

fromAddressstring

Minimum length: 1

toAddressesarray<string>

notificationId
Required
string

Minimum length: 1

emailId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.updateEmail" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "vexorpayRestart": true,
  "name": "string",
  "appDeploy": true,
  "dockerCleanup": true,
  "smtpServer": "string",
  "smtpPort": 1,
  "username": "string",
  "password": "string",
  "fromAddress": "string",
  "toAddresses": [
    "string"
  ],
  "notificationId": "string",
  "emailId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.testEmailConnection

notification-testEmailConnection

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

smtpServer
Required
string

Minimum length: 1

smtpPort
Required
number

Minimum: 1

username
Required
string

Minimum length: 1

password
Required
string

Minimum length: 1

toAddresses
Required
array<string>

fromAddress
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.testEmailConnection" \
  -d '{
  "smtpServer": "string",
  "smtpPort": 1,
  "username": "string",
  "password": "string",
  "toAddresses": [
    "string"
  ],
  "fromAddress": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/notification.remove

notification-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

notificationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/notification.remove" \
  -d '{
  "notificationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/notification.one

notification-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

notificationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/notification.one?notificationId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/notification.all

notification-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/notification.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Next

Vexor API

On this page

notification-createSlackAuthorizationRequest Bodynotification-updateSlackAuthorizationRequest Bodynotification-testSlackConnectionAuthorizationRequest Bodynotification-createTelegramAuthorizationRequest Bodynotification-updateTelegramAuthorizationRequest Bodynotification-testTelegramConnectionAuthorizationRequest Bodynotification-createDiscordAuthorizationRequest Bodynotification-updateDiscordAuthorizationRequest Bodynotification-testDiscordConnectionAuthorizationRequest Bodynotification-createEmailAuthorizationRequest Bodynotification-updateEmailAuthorizationRequest Bodynotification-testEmailConnectionAuthorizationRequest Bodynotification-removeAuthorizationRequest Bodynotification-oneAuthorizationQuery Parametersnotification-allAuthorization