Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Nettalco/dokploy/llms.txt

Use this file to discover all available pages before exploring further.

The Notifications API lets you connect Dokploy to any alerting channel so your team is instantly informed of deployment successes, failures, and other system events. Each notification provider has its own create and update endpoints, plus a test endpoint to verify connectivity before going live. You can register multiple notification channels and configure which event types trigger each one.

​
Endpoints

MethodEndpointDescription
POST/notification.createSlackCreate a Slack notification
POST/notification.updateSlackUpdate a Slack notification
POST/notification.testSlackConnectionTest a Slack webhook
POST/notification.createTelegramCreate a Telegram notification
POST/notification.updateTelegramUpdate a Telegram notification
POST/notification.testTelegramConnectionTest a Telegram bot connection
POST/notification.createDiscordCreate a Discord notification
POST/notification.updateDiscordUpdate a Discord notification
POST/notification.testDiscordConnectionTest a Discord webhook
POST/notification.createEmailCreate an SMTP email notification
POST/notification.updateEmailUpdate an SMTP email notification
POST/notification.testEmailConnectionTest the email connection
POST/notification.createResendCreate a Resend email notification
POST/notification.updateResendUpdate a Resend notification
POST/notification.testResendConnectionTest the Resend connection
POST/notification.createGotifyCreate a Gotify notification
POST/notification.updateGotifyUpdate a Gotify notification
POST/notification.testGotifyConnectionTest a Gotify connection
POST/notification.createNtfyCreate an Ntfy notification
POST/notification.updateNtfyUpdate an Ntfy notification
POST/notification.testNtfyConnectionTest an Ntfy connection
POST/notification.createCustomCreate a custom webhook notification
POST/notification.updateCustomUpdate a custom webhook notification
POST/notification.testCustomConnectionTest a custom webhook connection
POST/notification.createLarkCreate a Lark notification
POST/notification.updateLarkUpdate a Lark notification
POST/notification.testLarkConnectionTest a Lark connection
POST/notification.createTeamsCreate a Microsoft Teams notification
POST/notification.updateTeamsUpdate a Teams notification
POST/notification.testTeamsConnectionTest a Teams connection
POST/notification.createPushoverCreate a Pushover notification
POST/notification.updatePushoverUpdate a Pushover notification
POST/notification.testPushoverConnectionTest a Pushover connection
POST/notification.removeDelete a notification channel
GET/notification.oneFetch a notification channel by ID
GET/notification.allList all notification channels
POST/notification.receiveNotificationSend a test event to a channel

​
Key Endpoints

​
POST /notification.createSlack

Set up a Slack notification channel using an Incoming Webhook URL.
​
name
string
required
Display name for this notification channel.
​
webhookUrl
string
required
Slack Incoming Webhook URL from your Slack app configuration.
​
channel
string
Slack channel to post to (e.g., #deployments). Overrides the webhook default if set.
​
appDeploy
boolean
Notify on successful application deployments (default: true).
​
appBuildError
boolean
Notify on build failures (default: true).
​
databaseBackup
boolean
Notify on database backup completions.
​
dokployRestart
boolean
Notify when the Dokploy service restarts.
​
notificationId
string
Unique ID of the created notification channel.
curl -X POST 'https://your-instance.com/api/notification.createSlack' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "prod-deploy-alerts",
    "webhookUrl": "https://hooks.slack.com/services/T00000/B00000/XXXXXXXX",
    "channel": "#deployments",
    "appDeploy": true,
    "appBuildError": true,
    "databaseBackup": false,
    "dokployRestart": true
  }'

​
POST /notification.createTelegram

Set up a Telegram notification using a bot token and chat ID.
​
name
string
required
Display name for this notification channel.
​
botToken
string
required
Telegram bot token from @BotFather.
​
chatId
string
required
Telegram chat ID (user, group, or channel) to send messages to.
​
appDeploy
boolean
Notify on successful application deployments.
​
appBuildError
boolean
Notify on build failures.
curl -X POST 'https://your-instance.com/api/notification.createTelegram' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "telegram-alerts",
    "botToken": "123456789:AABBccDDeeFFggHHiiJJkkLLmmNNooP",
    "chatId": "-1001234567890",
    "appDeploy": true,
    "appBuildError": true
  }'

​
POST /notification.createDiscord

Create a Discord notification channel via a webhook URL.
​
name
string
required
Display name for this notification channel.
​
webhookUrl
string
required
Discord channel webhook URL.
​
appDeploy
boolean
Notify on successful deployments.
​
appBuildError
boolean
Notify on build failures.
curl -X POST 'https://your-instance.com/api/notification.createDiscord' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "discord-deploy-bot",
    "webhookUrl": "https://discord.com/api/webhooks/1234567890/XXXXXXXX",
    "appDeploy": true,
    "appBuildError": true
  }'

​
POST /notification.testSlackConnection

Send a test message to verify the Slack webhook is working before enabling notifications.
​
notificationId
string
required
ID of the Slack notification channel to test.
curl -X POST 'https://your-instance.com/api/notification.testSlackConnection' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "notificationId": "notif_abc123"
  }'

​
POST /notification.createCustom

Register a custom HTTP webhook endpoint that receives Dokploy event payloads as JSON.
​
name
string
required
Display name for the webhook.
​
webhookUrl
string
required
URL of the endpoint to POST events to.
​
secret
string
Optional HMAC secret to sign payloads for verification.
​
appDeploy
boolean
Send notifications on application deployments.
​
appBuildError
boolean
Send notifications on build failures.
curl -X POST 'https://your-instance.com/api/notification.createCustom' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-webhook",
    "webhookUrl": "https://example.com/hooks/dokploy",
    "appDeploy": true,
    "appBuildError": true
  }'

​
Notes

Always call the provider-specific test endpoint (e.g., testSlackConnection) right after creation to confirm the channel is working before it matters during a production incident.
You can register multiple notification channels of the same or different types. All enabled channels receive the same event notifications simultaneously.

Build docs developers (and LLMs) love

Get started for freeTalk to us