notification

POST`/notification.createSlack`

notification-createSlack

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`appBuildError`
Required
boolean

`databaseBackup`
Required
boolean

`dokployRestart`
Required
boolean

`name`
Required
string

`appDeploy`
Required
boolean

`dockerCleanup`
Required
boolean

`webhookUrl`
Required
string

Minimum length: 1

`channel`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.createSlack" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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

`appBuildError`boolean

`databaseBackup`boolean

`dokployRestart`boolean

`name`string

`appDeploy`boolean

`dockerCleanup`boolean

`webhookUrl`string

Minimum length: 1

`channel`string

`notificationId`
Required
string

Minimum length: 1

`slackId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.updateSlack" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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 code	Description
`200`	Successful response
`default`	Error 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

`dokployRestart`
Required
boolean

`name`
Required
string

`appDeploy`
Required
boolean

`dockerCleanup`
Required
boolean

`botToken`
Required
string

Minimum length: 1

`chatId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.createTelegram" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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

`appBuildError`boolean

`databaseBackup`boolean

`dokployRestart`boolean

`name`string

`appDeploy`boolean

`dockerCleanup`boolean

`botToken`string

Minimum length: 1

`chatId`string

Minimum length: 1

`notificationId`
Required
string

Minimum length: 1

`telegramId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.updateTelegram" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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 code	Description
`200`	Successful response
`default`	Error 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

`dokployRestart`
Required
boolean

`name`
Required
string

`appDeploy`
Required
boolean

`dockerCleanup`
Required
boolean

`webhookUrl`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.createDiscord" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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

`appBuildError`boolean

`databaseBackup`boolean

`dokployRestart`boolean

`name`string

`appDeploy`boolean

`dockerCleanup`boolean

`webhookUrl`string

Minimum length: 1

`notificationId`
Required
string

Minimum length: 1

`discordId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.updateDiscord" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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 code	Description
`200`	Successful response
`default`	Error 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

`dokployRestart`
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 code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.createEmail" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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

`appBuildError`boolean

`databaseBackup`boolean

`dokployRestart`boolean

`name`string

`appDeploy`boolean

`dockerCleanup`boolean

`smtpServer`string

Minimum length: 1

`smtpPort`number

Minimum: 1

`username`string

Minimum length: 1

`password`string

Minimum length: 1

`fromAddress`string

Minimum length: 1

`toAddresses`array<string>

`notificationId`
Required
string

Minimum length: 1

`emailId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/notification.updateEmail" \
  -d '{
  "appBuildError": true,
  "databaseBackup": true,
  "dokployRestart": 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/notification.all"

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

notification

POST/notification.createSlack

AuthorizationRequiredBearer <token>

appBuildErrorRequiredboolean

databaseBackupRequiredboolean

dokployRestartRequiredboolean

nameRequiredstring

appDeployRequiredboolean

dockerCleanupRequiredboolean

webhookUrlRequiredstring

channelRequiredstring

Response

Typescript

POST/notification.updateSlack

AuthorizationRequiredBearer <token>

appBuildErrorboolean

databaseBackupboolean

dokployRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

webhookUrlstring

channelstring

notificationIdRequiredstring

slackIdRequiredstring

Response

Typescript

POST/notification.testSlackConnection

AuthorizationRequiredBearer <token>

webhookUrlRequiredstring

channelRequiredstring

Response

Typescript

POST/notification.createTelegram

AuthorizationRequiredBearer <token>

appBuildErrorRequiredboolean

databaseBackupRequiredboolean

dokployRestartRequiredboolean

nameRequiredstring

appDeployRequiredboolean

dockerCleanupRequiredboolean

botTokenRequiredstring

chatIdRequiredstring

Response

Typescript

POST/notification.updateTelegram

AuthorizationRequiredBearer <token>

appBuildErrorboolean

databaseBackupboolean

dokployRestartboolean

namestring

appDeployboolean

dockerCleanupboolean

botTokenstring

chatIdstring

notificationIdRequiredstring

telegramIdRequiredstring

Response

Typescript

POST/notification.testTelegramConnection

AuthorizationRequiredBearer <token>

botTokenRequiredstring

chatIdRequiredstring

Response

Typescript

POST/notification.createDiscord

AuthorizationRequiredBearer <token>

appBuildErrorRequiredboolean

databaseBackupRequiredboolean

dokployRestartRequiredboolean

nameRequiredstring

appDeployRequiredboolean

dockerCleanupRequiredboolean

webhookUrlRequiredstring

Response

Typescript

POST/notification.updateDiscord

AuthorizationRequiredBearer <token>

appBuildErrorboolean

databaseBackupboolean

POST`/notification.createSlack`

`Authorization`
Required
Bearer <token>

`appBuildError`
Required
boolean

`databaseBackup`
Required
boolean

`dokployRestart`
Required
boolean

`name`
Required
string

`appDeploy`
Required
boolean

`dockerCleanup`
Required
boolean

`webhookUrl`
Required
string

`channel`
Required
string

POST`/notification.updateSlack`

`Authorization`
Required
Bearer <token>

`appBuildError`boolean

`databaseBackup`boolean

`dokployRestart`boolean

`name`string

`appDeploy`boolean

`dockerCleanup`boolean

`webhookUrl`string

`channel`string

`notificationId`
Required
string

`slackId`
Required
string

POST`/notification.testSlackConnection`

`Authorization`
Required
Bearer <token>

`webhookUrl`
Required
string

`channel`
Required
string

POST`/notification.createTelegram`

`Authorization`
Required
Bearer <token>

`appBuildError`
Required
boolean

`databaseBackup`
Required
boolean

`dokployRestart`
Required
boolean

`name`
Required
string

`appDeploy`
Required
boolean

`dockerCleanup`
Required
boolean

`botToken`
Required
string

`chatId`
Required
string

POST`/notification.updateTelegram`

`Authorization`
Required
Bearer <token>

`appBuildError`boolean

`databaseBackup`boolean

`dokployRestart`boolean

`name`string

`appDeploy`boolean

`dockerCleanup`boolean

`botToken`string

`chatId`string

`notificationId`
Required
string

`telegramId`
Required
string

POST`/notification.testTelegramConnection`

`Authorization`
Required
Bearer <token>

`botToken`
Required
string

`chatId`
Required
string

POST`/notification.createDiscord`

`Authorization`
Required
Bearer <token>

`appBuildError`
Required
boolean

`databaseBackup`
Required
boolean

`dokployRestart`
Required
boolean

`name`
Required
string

`appDeploy`
Required
boolean

`dockerCleanup`
Required
boolean

`webhookUrl`
Required
string

POST`/notification.updateDiscord`

`Authorization`
Required
Bearer <token>

`appBuildError`boolean

`databaseBackup`boolean

`dokployRestart`boolean

`name`string

`appDeploy`boolean

`dockerCleanup`boolean

`webhookUrl`string

`notificationId`
Required
string

`discordId`
Required
string

POST`/notification.testDiscordConnection`

`Authorization`
Required
Bearer <token>

`webhookUrl`
Required
string

POST`/notification.createEmail`

`Authorization`
Required
Bearer <token>

`appBuildError`
Required
boolean

`databaseBackup`
Required
boolean

`dokployRestart`
Required
boolean