published on Thursday, Nov 5, 2026 by dimeskigj
published on Thursday, Nov 5, 2026 by dimeskigj
A Dokploy notification destination and its event subscriptions.
Create Notification Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Notification(name: string, args: NotificationArgs, opts?: CustomResourceOptions);@overload
def Notification(resource_name: str,
args: NotificationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Notification(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
mattermost: Optional[NotificationMattermostConfigArgs] = None,
email: Optional[NotificationEmailConfigArgs] = None,
events: Optional[NotificationEventsArgs] = None,
gotify: Optional[NotificationGotifyConfigArgs] = None,
lark: Optional[NotificationLarkConfigArgs] = None,
custom: Optional[NotificationCustomConfigArgs] = None,
discord: Optional[NotificationDiscordConfigArgs] = None,
ntfy: Optional[NotificationNtfyConfigArgs] = None,
pushover: Optional[NotificationPushoverConfigArgs] = None,
resend: Optional[NotificationResendConfigArgs] = None,
slack: Optional[NotificationSlackConfigArgs] = None,
teams: Optional[NotificationTeamsConfigArgs] = None,
telegram: Optional[NotificationTelegramConfigArgs] = None)func NewNotification(ctx *Context, name string, args NotificationArgs, opts ...ResourceOption) (*Notification, error)public Notification(string name, NotificationArgs args, CustomResourceOptions? opts = null)
public Notification(String name, NotificationArgs args)
public Notification(String name, NotificationArgs args, CustomResourceOptions options)
type: dokploy:Notification
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "dokploy_notification" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args NotificationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NotificationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NotificationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NotificationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NotificationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var notificationResource = new Dokploy.Notification("notificationResource", new()
{
Name = "string",
Mattermost = new Dokploy.Inputs.NotificationMattermostConfigArgs
{
WebhookUrl = "string",
Channel = "string",
Username = "string",
},
Email = new Dokploy.Inputs.NotificationEmailConfigArgs
{
FromAddress = "string",
Password = "string",
SmtpPort = 0,
SmtpServer = "string",
ToAddresses = new[]
{
"string",
},
Username = "string",
},
Events = new Dokploy.Inputs.NotificationEventsArgs
{
AppBuildError = false,
AppDeploy = false,
DatabaseBackup = false,
DockerCleanup = false,
DokployBackup = false,
DokployRestart = false,
ServerThreshold = false,
VolumeBackup = false,
},
Gotify = new Dokploy.Inputs.NotificationGotifyConfigArgs
{
AppToken = "string",
ServerUrl = "string",
Decoration = false,
Priority = 0,
},
Lark = new Dokploy.Inputs.NotificationLarkConfigArgs
{
WebhookUrl = "string",
},
Custom = new Dokploy.Inputs.NotificationCustomConfigArgs
{
Endpoint = "string",
Headers =
{
{ "string", "string" },
},
},
Discord = new Dokploy.Inputs.NotificationDiscordConfigArgs
{
WebhookUrl = "string",
Decoration = false,
},
Ntfy = new Dokploy.Inputs.NotificationNtfyConfigArgs
{
ServerUrl = "string",
Topic = "string",
AccessToken = "string",
Priority = 0,
},
Pushover = new Dokploy.Inputs.NotificationPushoverConfigArgs
{
ApiToken = "string",
UserKey = "string",
Expire = 0,
Priority = 0,
Retry = 0,
},
Resend = new Dokploy.Inputs.NotificationResendConfigArgs
{
ApiKey = "string",
FromAddress = "string",
ToAddresses = new[]
{
"string",
},
},
Slack = new Dokploy.Inputs.NotificationSlackConfigArgs
{
WebhookUrl = "string",
Channel = "string",
},
Teams = new Dokploy.Inputs.NotificationTeamsConfigArgs
{
WebhookUrl = "string",
},
Telegram = new Dokploy.Inputs.NotificationTelegramConfigArgs
{
BotToken = "string",
ChatId = "string",
MessageThreadId = "string",
},
});
example, err := dokploy.NewNotification(ctx, "notificationResource", &dokploy.NotificationArgs{
Name: pulumi.String("string"),
Mattermost: &dokploy.NotificationMattermostConfigArgs{
WebhookUrl: pulumi.String("string"),
Channel: pulumi.String("string"),
Username: pulumi.String("string"),
},
Email: &dokploy.NotificationEmailConfigArgs{
FromAddress: pulumi.String("string"),
Password: pulumi.String("string"),
SmtpPort: pulumi.Int(0),
SmtpServer: pulumi.String("string"),
ToAddresses: pulumi.StringArray{
pulumi.String("string"),
},
Username: pulumi.String("string"),
},
Events: &dokploy.NotificationEventsArgs{
AppBuildError: pulumi.Bool(false),
AppDeploy: pulumi.Bool(false),
DatabaseBackup: pulumi.Bool(false),
DockerCleanup: pulumi.Bool(false),
DokployBackup: pulumi.Bool(false),
DokployRestart: pulumi.Bool(false),
ServerThreshold: pulumi.Bool(false),
VolumeBackup: pulumi.Bool(false),
},
Gotify: &dokploy.NotificationGotifyConfigArgs{
AppToken: pulumi.String("string"),
ServerUrl: pulumi.String("string"),
Decoration: pulumi.Bool(false),
Priority: pulumi.Int(0),
},
Lark: &dokploy.NotificationLarkConfigArgs{
WebhookUrl: pulumi.String("string"),
},
Custom: &dokploy.NotificationCustomConfigArgs{
Endpoint: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
Discord: &dokploy.NotificationDiscordConfigArgs{
WebhookUrl: pulumi.String("string"),
Decoration: pulumi.Bool(false),
},
Ntfy: &dokploy.NotificationNtfyConfigArgs{
ServerUrl: pulumi.String("string"),
Topic: pulumi.String("string"),
AccessToken: pulumi.String("string"),
Priority: pulumi.Int(0),
},
Pushover: &dokploy.NotificationPushoverConfigArgs{
ApiToken: pulumi.String("string"),
UserKey: pulumi.String("string"),
Expire: pulumi.Int(0),
Priority: pulumi.Int(0),
Retry: pulumi.Int(0),
},
Resend: &dokploy.NotificationResendConfigArgs{
ApiKey: pulumi.String("string"),
FromAddress: pulumi.String("string"),
ToAddresses: pulumi.StringArray{
pulumi.String("string"),
},
},
Slack: &dokploy.NotificationSlackConfigArgs{
WebhookUrl: pulumi.String("string"),
Channel: pulumi.String("string"),
},
Teams: &dokploy.NotificationTeamsConfigArgs{
WebhookUrl: pulumi.String("string"),
},
Telegram: &dokploy.NotificationTelegramConfigArgs{
BotToken: pulumi.String("string"),
ChatId: pulumi.String("string"),
MessageThreadId: pulumi.String("string"),
},
})
resource "dokploy_notification" "notificationResource" {
lifecycle {
create_before_destroy = true
}
name = "string"
mattermost = {
webhook_url = "string"
channel = "string"
username = "string"
}
email = {
from_address = "string"
password = "string"
smtp_port = 0
smtp_server = "string"
to_addresses = ["string"]
username = "string"
}
events = {
app_build_error = false
app_deploy = false
database_backup = false
docker_cleanup = false
dokploy_backup = false
dokploy_restart = false
server_threshold = false
volume_backup = false
}
gotify = {
app_token = "string"
server_url = "string"
decoration = false
priority = 0
}
lark = {
webhook_url = "string"
}
custom = {
endpoint = "string"
headers = {
"string" = "string"
}
}
discord = {
webhook_url = "string"
decoration = false
}
ntfy = {
server_url = "string"
topic = "string"
access_token = "string"
priority = 0
}
pushover = {
api_token = "string"
user_key = "string"
expire = 0
priority = 0
retry = 0
}
resend = {
api_key = "string"
from_address = "string"
to_addresses = ["string"]
}
slack = {
webhook_url = "string"
channel = "string"
}
teams = {
webhook_url = "string"
}
telegram = {
bot_token = "string"
chat_id = "string"
message_thread_id = "string"
}
}
var notificationResource = new Notification("notificationResource", NotificationArgs.builder()
.name("string")
.mattermost(NotificationMattermostConfigArgs.builder()
.webhookUrl("string")
.channel("string")
.username("string")
.build())
.email(NotificationEmailConfigArgs.builder()
.fromAddress("string")
.password("string")
.smtpPort(0)
.smtpServer("string")
.toAddresses("string")
.username("string")
.build())
.events(NotificationEventsArgs.builder()
.appBuildError(false)
.appDeploy(false)
.databaseBackup(false)
.dockerCleanup(false)
.dokployBackup(false)
.dokployRestart(false)
.serverThreshold(false)
.volumeBackup(false)
.build())
.gotify(NotificationGotifyConfigArgs.builder()
.appToken("string")
.serverUrl("string")
.decoration(false)
.priority(0)
.build())
.lark(NotificationLarkConfigArgs.builder()
.webhookUrl("string")
.build())
.custom(NotificationCustomConfigArgs.builder()
.endpoint("string")
.headers(Map.of("string", "string"))
.build())
.discord(NotificationDiscordConfigArgs.builder()
.webhookUrl("string")
.decoration(false)
.build())
.ntfy(NotificationNtfyConfigArgs.builder()
.serverUrl("string")
.topic("string")
.accessToken("string")
.priority(0)
.build())
.pushover(NotificationPushoverConfigArgs.builder()
.apiToken("string")
.userKey("string")
.expire(0)
.priority(0)
.retry(0)
.build())
.resend(NotificationResendConfigArgs.builder()
.apiKey("string")
.fromAddress("string")
.toAddresses("string")
.build())
.slack(NotificationSlackConfigArgs.builder()
.webhookUrl("string")
.channel("string")
.build())
.teams(NotificationTeamsConfigArgs.builder()
.webhookUrl("string")
.build())
.telegram(NotificationTelegramConfigArgs.builder()
.botToken("string")
.chatId("string")
.messageThreadId("string")
.build())
.build());
notification_resource = dokploy.Notification("notificationResource",
name="string",
mattermost={
"webhook_url": "string",
"channel": "string",
"username": "string",
},
email={
"from_address": "string",
"password": "string",
"smtp_port": 0,
"smtp_server": "string",
"to_addresses": ["string"],
"username": "string",
},
events={
"app_build_error": False,
"app_deploy": False,
"database_backup": False,
"docker_cleanup": False,
"dokploy_backup": False,
"dokploy_restart": False,
"server_threshold": False,
"volume_backup": False,
},
gotify={
"app_token": "string",
"server_url": "string",
"decoration": False,
"priority": 0,
},
lark={
"webhook_url": "string",
},
custom={
"endpoint": "string",
"headers": {
"string": "string",
},
},
discord={
"webhook_url": "string",
"decoration": False,
},
ntfy={
"server_url": "string",
"topic": "string",
"access_token": "string",
"priority": 0,
},
pushover={
"api_token": "string",
"user_key": "string",
"expire": 0,
"priority": 0,
"retry": 0,
},
resend={
"api_key": "string",
"from_address": "string",
"to_addresses": ["string"],
},
slack={
"webhook_url": "string",
"channel": "string",
},
teams={
"webhook_url": "string",
},
telegram={
"bot_token": "string",
"chat_id": "string",
"message_thread_id": "string",
})
const notificationResource = new dokploy.Notification("notificationResource", {
name: "string",
mattermost: {
webhookUrl: "string",
channel: "string",
username: "string",
},
email: {
fromAddress: "string",
password: "string",
smtpPort: 0,
smtpServer: "string",
toAddresses: ["string"],
username: "string",
},
events: {
appBuildError: false,
appDeploy: false,
databaseBackup: false,
dockerCleanup: false,
dokployBackup: false,
dokployRestart: false,
serverThreshold: false,
volumeBackup: false,
},
gotify: {
appToken: "string",
serverUrl: "string",
decoration: false,
priority: 0,
},
lark: {
webhookUrl: "string",
},
custom: {
endpoint: "string",
headers: {
string: "string",
},
},
discord: {
webhookUrl: "string",
decoration: false,
},
ntfy: {
serverUrl: "string",
topic: "string",
accessToken: "string",
priority: 0,
},
pushover: {
apiToken: "string",
userKey: "string",
expire: 0,
priority: 0,
retry: 0,
},
resend: {
apiKey: "string",
fromAddress: "string",
toAddresses: ["string"],
},
slack: {
webhookUrl: "string",
channel: "string",
},
teams: {
webhookUrl: "string",
},
telegram: {
botToken: "string",
chatId: "string",
messageThreadId: "string",
},
});
type: dokploy:Notification
properties:
custom:
endpoint: string
headers:
string: string
discord:
decoration: false
webhookUrl: string
email:
fromAddress: string
password: string
smtpPort: 0
smtpServer: string
toAddresses:
- string
username: string
events:
appBuildError: false
appDeploy: false
databaseBackup: false
dockerCleanup: false
dokployBackup: false
dokployRestart: false
serverThreshold: false
volumeBackup: false
gotify:
appToken: string
decoration: false
priority: 0
serverUrl: string
lark:
webhookUrl: string
mattermost:
channel: string
username: string
webhookUrl: string
name: string
ntfy:
accessToken: string
priority: 0
serverUrl: string
topic: string
pushover:
apiToken: string
expire: 0
priority: 0
retry: 0
userKey: string
resend:
apiKey: string
fromAddress: string
toAddresses:
- string
slack:
channel: string
webhookUrl: string
teams:
webhookUrl: string
telegram:
botToken: string
chatId: string
messageThreadId: string
Notification Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Notification resource accepts the following input properties:
- Name string
- Required notification name.
- Custom
Dimeskigj.
Notification Custom Config - Custom HTTP destination; select exactly one channel block.
- Discord
Dimeskigj.
Notification Discord Config - Discord destination; select exactly one channel block.
- Email
Dimeskigj.
Notification Email Config - SMTP email destination; select exactly one channel block.
- Events
Dimeskigj.
Notification Events - Optional event subscriptions; every omitted event defaults to false.
- Gotify
Dimeskigj.
Notification Gotify Config - Gotify destination; select exactly one channel block.
- Lark
Dimeskigj.
Notification Lark Config - Lark destination; select exactly one channel block.
- Mattermost
Dimeskigj.
Notification Mattermost Config - Mattermost destination; select exactly one channel block.
- Ntfy
Dimeskigj.
Notification Ntfy Config - Ntfy destination; select exactly one channel block.
- Pushover
Dimeskigj.
Notification Pushover Config - Pushover destination; select exactly one channel block.
- Resend
Dimeskigj.
Notification Resend Config - Resend email destination; select exactly one channel block.
- Slack
Dimeskigj.
Notification Slack Config - Slack destination; select exactly one channel block.
- Teams
Dimeskigj.
Notification Teams Config - Teams destination; select exactly one channel block.
- Telegram
Dimeskigj.
Notification Telegram Config - Telegram destination; select exactly one channel block.
- Name string
- Required notification name.
- Custom
Notification
Custom Config Args - Custom HTTP destination; select exactly one channel block.
- Discord
Notification
Discord Config Args - Discord destination; select exactly one channel block.
- Email
Notification
Email Config Args - SMTP email destination; select exactly one channel block.
- Events
Notification
Events Args - Optional event subscriptions; every omitted event defaults to false.
- Gotify
Notification
Gotify Config Args - Gotify destination; select exactly one channel block.
- Lark
Notification
Lark Config Args - Lark destination; select exactly one channel block.
- Mattermost
Notification
Mattermost Config Args - Mattermost destination; select exactly one channel block.
- Ntfy
Notification
Ntfy Config Args - Ntfy destination; select exactly one channel block.
- Pushover
Notification
Pushover Config Args - Pushover destination; select exactly one channel block.
- Resend
Notification
Resend Config Args - Resend email destination; select exactly one channel block.
- Slack
Notification
Slack Config Args - Slack destination; select exactly one channel block.
- Teams
Notification
Teams Config Args - Teams destination; select exactly one channel block.
- Telegram
Notification
Telegram Config Args - Telegram destination; select exactly one channel block.
- name string
- Required notification name.
- custom object
- Custom HTTP destination; select exactly one channel block.
- discord object
- Discord destination; select exactly one channel block.
- email object
- SMTP email destination; select exactly one channel block.
- events object
- Optional event subscriptions; every omitted event defaults to false.
- gotify object
- Gotify destination; select exactly one channel block.
- lark object
- Lark destination; select exactly one channel block.
- mattermost object
- Mattermost destination; select exactly one channel block.
- ntfy object
- Ntfy destination; select exactly one channel block.
- pushover object
- Pushover destination; select exactly one channel block.
- resend object
- Resend email destination; select exactly one channel block.
- slack object
- Slack destination; select exactly one channel block.
- teams object
- Teams destination; select exactly one channel block.
- telegram object
- Telegram destination; select exactly one channel block.
- name String
- Required notification name.
- custom
Notification
Custom Config - Custom HTTP destination; select exactly one channel block.
- discord
Notification
Discord Config - Discord destination; select exactly one channel block.
- email
Notification
Email Config - SMTP email destination; select exactly one channel block.
- events
Notification
Events - Optional event subscriptions; every omitted event defaults to false.
- gotify
Notification
Gotify Config - Gotify destination; select exactly one channel block.
- lark
Notification
Lark Config - Lark destination; select exactly one channel block.
- mattermost
Notification
Mattermost Config - Mattermost destination; select exactly one channel block.
- ntfy
Notification
Ntfy Config - Ntfy destination; select exactly one channel block.
- pushover
Notification
Pushover Config - Pushover destination; select exactly one channel block.
- resend
Notification
Resend Config - Resend email destination; select exactly one channel block.
- slack
Notification
Slack Config - Slack destination; select exactly one channel block.
- teams
Notification
Teams Config - Teams destination; select exactly one channel block.
- telegram
Notification
Telegram Config - Telegram destination; select exactly one channel block.
- name string
- Required notification name.
- custom
Notification
Custom Config - Custom HTTP destination; select exactly one channel block.
- discord
Notification
Discord Config - Discord destination; select exactly one channel block.
- email
Notification
Email Config - SMTP email destination; select exactly one channel block.
- events
Notification
Events - Optional event subscriptions; every omitted event defaults to false.
- gotify
Notification
Gotify Config - Gotify destination; select exactly one channel block.
- lark
Notification
Lark Config - Lark destination; select exactly one channel block.
- mattermost
Notification
Mattermost Config - Mattermost destination; select exactly one channel block.
- ntfy
Notification
Ntfy Config - Ntfy destination; select exactly one channel block.
- pushover
Notification
Pushover Config - Pushover destination; select exactly one channel block.
- resend
Notification
Resend Config - Resend email destination; select exactly one channel block.
- slack
Notification
Slack Config - Slack destination; select exactly one channel block.
- teams
Notification
Teams Config - Teams destination; select exactly one channel block.
- telegram
Notification
Telegram Config - Telegram destination; select exactly one channel block.
- name str
- Required notification name.
- custom
Notification
Custom Config Args - Custom HTTP destination; select exactly one channel block.
- discord
Notification
Discord Config Args - Discord destination; select exactly one channel block.
- email
Notification
Email Config Args - SMTP email destination; select exactly one channel block.
- events
Notification
Events Args - Optional event subscriptions; every omitted event defaults to false.
- gotify
Notification
Gotify Config Args - Gotify destination; select exactly one channel block.
- lark
Notification
Lark Config Args - Lark destination; select exactly one channel block.
- mattermost
Notification
Mattermost Config Args - Mattermost destination; select exactly one channel block.
- ntfy
Notification
Ntfy Config Args - Ntfy destination; select exactly one channel block.
- pushover
Notification
Pushover Config Args - Pushover destination; select exactly one channel block.
- resend
Notification
Resend Config Args - Resend email destination; select exactly one channel block.
- slack
Notification
Slack Config Args - Slack destination; select exactly one channel block.
- teams
Notification
Teams Config Args - Teams destination; select exactly one channel block.
- telegram
Notification
Telegram Config Args - Telegram destination; select exactly one channel block.
- name String
- Required notification name.
- custom Property Map
- Custom HTTP destination; select exactly one channel block.
- discord Property Map
- Discord destination; select exactly one channel block.
- email Property Map
- SMTP email destination; select exactly one channel block.
- events Property Map
- Optional event subscriptions; every omitted event defaults to false.
- gotify Property Map
- Gotify destination; select exactly one channel block.
- lark Property Map
- Lark destination; select exactly one channel block.
- mattermost Property Map
- Mattermost destination; select exactly one channel block.
- ntfy Property Map
- Ntfy destination; select exactly one channel block.
- pushover Property Map
- Pushover destination; select exactly one channel block.
- resend Property Map
- Resend email destination; select exactly one channel block.
- slack Property Map
- Slack destination; select exactly one channel block.
- teams Property Map
- Teams destination; select exactly one channel block.
- telegram Property Map
- Telegram destination; select exactly one channel block.
Outputs
All input properties are implicitly available as output properties. Additionally, the Notification resource produces the following output properties:
- Channel
Id string - Stable selected channel relation ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Notification
Id string - Stable Dokploy notification ID.
- Notification
Type string - Selected notification channel type.
- Organization
Id string - Owning Dokploy organization ID.
- Channel
Id string - Stable selected channel relation ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Notification
Id string - Stable Dokploy notification ID.
- Notification
Type string - Selected notification channel type.
- Organization
Id string - Owning Dokploy organization ID.
- channel_
id string - Stable selected channel relation ID.
- id string
- The provider-assigned unique ID for this managed resource.
- notification_
id string - Stable Dokploy notification ID.
- notification_
type string - Selected notification channel type.
- organization_
id string - Owning Dokploy organization ID.
- channel
Id String - Stable selected channel relation ID.
- id String
- The provider-assigned unique ID for this managed resource.
- notification
Id String - Stable Dokploy notification ID.
- notification
Type String - Selected notification channel type.
- organization
Id String - Owning Dokploy organization ID.
- channel
Id string - Stable selected channel relation ID.
- id string
- The provider-assigned unique ID for this managed resource.
- notification
Id string - Stable Dokploy notification ID.
- notification
Type string - Selected notification channel type.
- organization
Id string - Owning Dokploy organization ID.
- channel_
id str - Stable selected channel relation ID.
- id str
- The provider-assigned unique ID for this managed resource.
- notification_
id str - Stable Dokploy notification ID.
- notification_
type str - Selected notification channel type.
- organization_
id str - Owning Dokploy organization ID.
- channel
Id String - Stable selected channel relation ID.
- id String
- The provider-assigned unique ID for this managed resource.
- notification
Id String - Stable Dokploy notification ID.
- notification
Type String - Selected notification channel type.
- organization
Id String - Owning Dokploy organization ID.
Look up Existing Notification Resource
Get an existing Notification resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Notification@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Notificationfunc GetNotification(ctx *Context, name string, id IDInput, state *NotificationState, opts ...ResourceOption) (*Notification, error)public static Notification Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Notification get(String name, Output<String> id, CustomResourceOptions options)resources: existingNotification: type: dokploy:Notification get: id: ${id}import {
to = dokploy_notification.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state NotificationState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
NotificationCustomConfig, NotificationCustomConfigArgs
NotificationDiscordConfig, NotificationDiscordConfigArgs
- Webhook
Url string - Secret Discord webhook URL.
- Decoration bool
- Whether to decorate messages; defaults to false.
- Webhook
Url string - Secret Discord webhook URL.
- Decoration bool
- Whether to decorate messages; defaults to false.
- webhook_
url string - Secret Discord webhook URL.
- decoration bool
- Whether to decorate messages; defaults to false.
- webhook
Url String - Secret Discord webhook URL.
- decoration Boolean
- Whether to decorate messages; defaults to false.
- webhook
Url string - Secret Discord webhook URL.
- decoration boolean
- Whether to decorate messages; defaults to false.
- webhook_
url str - Secret Discord webhook URL.
- decoration bool
- Whether to decorate messages; defaults to false.
- webhook
Url String - Secret Discord webhook URL.
- decoration Boolean
- Whether to decorate messages; defaults to false.
NotificationEmailConfig, NotificationEmailConfigArgs
- From
Address string - Sender address.
- Password string
- Secret SMTP password.
- Smtp
Port int - SMTP port from 1 through 65535.
- Smtp
Server string - SMTP server hostname.
- To
Addresses List<string> - Nonempty list of recipient addresses.
- Username string
- SMTP username.
- From
Address string - Sender address.
- Password string
- Secret SMTP password.
- Smtp
Port int - SMTP port from 1 through 65535.
- Smtp
Server string - SMTP server hostname.
- To
Addresses []string - Nonempty list of recipient addresses.
- Username string
- SMTP username.
- from_
address string - Sender address.
- password string
- Secret SMTP password.
- smtp_
port number - SMTP port from 1 through 65535.
- smtp_
server string - SMTP server hostname.
- to_
addresses list(string) - Nonempty list of recipient addresses.
- username string
- SMTP username.
- from
Address String - Sender address.
- password String
- Secret SMTP password.
- smtp
Port Integer - SMTP port from 1 through 65535.
- smtp
Server String - SMTP server hostname.
- to
Addresses List<String> - Nonempty list of recipient addresses.
- username String
- SMTP username.
- from
Address string - Sender address.
- password string
- Secret SMTP password.
- smtp
Port number - SMTP port from 1 through 65535.
- smtp
Server string - SMTP server hostname.
- to
Addresses string[] - Nonempty list of recipient addresses.
- username string
- SMTP username.
- from_
address str - Sender address.
- password str
- Secret SMTP password.
- smtp_
port int - SMTP port from 1 through 65535.
- smtp_
server str - SMTP server hostname.
- to_
addresses Sequence[str] - Nonempty list of recipient addresses.
- username str
- SMTP username.
- from
Address String - Sender address.
- password String
- Secret SMTP password.
- smtp
Port Number - SMTP port from 1 through 65535.
- smtp
Server String - SMTP server hostname.
- to
Addresses List<String> - Nonempty list of recipient addresses.
- username String
- SMTP username.
NotificationEvents, NotificationEventsArgs
- App
Build boolError - Notify on application build error; defaults to false.
- App
Deploy bool - Notify on application deployment; defaults to false.
- Database
Backup bool - Notify on database backup; defaults to false.
- Docker
Cleanup bool - Notify on Docker cleanup; defaults to false.
- Dokploy
Backup bool - Notify on Dokploy backup; defaults to false.
- Dokploy
Restart bool - Notify on Dokploy restart; defaults to false.
- Server
Threshold bool - Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
- Volume
Backup bool - Notify on volume backup; defaults to false.
- App
Build boolError - Notify on application build error; defaults to false.
- App
Deploy bool - Notify on application deployment; defaults to false.
- Database
Backup bool - Notify on database backup; defaults to false.
- Docker
Cleanup bool - Notify on Docker cleanup; defaults to false.
- Dokploy
Backup bool - Notify on Dokploy backup; defaults to false.
- Dokploy
Restart bool - Notify on Dokploy restart; defaults to false.
- Server
Threshold bool - Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
- Volume
Backup bool - Notify on volume backup; defaults to false.
- app_
build_ boolerror - Notify on application build error; defaults to false.
- app_
deploy bool - Notify on application deployment; defaults to false.
- database_
backup bool - Notify on database backup; defaults to false.
- docker_
cleanup bool - Notify on Docker cleanup; defaults to false.
- dokploy_
backup bool - Notify on Dokploy backup; defaults to false.
- dokploy_
restart bool - Notify on Dokploy restart; defaults to false.
- server_
threshold bool - Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
- volume_
backup bool - Notify on volume backup; defaults to false.
- app
Build BooleanError - Notify on application build error; defaults to false.
- app
Deploy Boolean - Notify on application deployment; defaults to false.
- database
Backup Boolean - Notify on database backup; defaults to false.
- docker
Cleanup Boolean - Notify on Docker cleanup; defaults to false.
- dokploy
Backup Boolean - Notify on Dokploy backup; defaults to false.
- dokploy
Restart Boolean - Notify on Dokploy restart; defaults to false.
- server
Threshold Boolean - Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
- volume
Backup Boolean - Notify on volume backup; defaults to false.
- app
Build booleanError - Notify on application build error; defaults to false.
- app
Deploy boolean - Notify on application deployment; defaults to false.
- database
Backup boolean - Notify on database backup; defaults to false.
- docker
Cleanup boolean - Notify on Docker cleanup; defaults to false.
- dokploy
Backup boolean - Notify on Dokploy backup; defaults to false.
- dokploy
Restart boolean - Notify on Dokploy restart; defaults to false.
- server
Threshold boolean - Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
- volume
Backup boolean - Notify on volume backup; defaults to false.
- app_
build_ boolerror - Notify on application build error; defaults to false.
- app_
deploy bool - Notify on application deployment; defaults to false.
- database_
backup bool - Notify on database backup; defaults to false.
- docker_
cleanup bool - Notify on Docker cleanup; defaults to false.
- dokploy_
backup bool - Notify on Dokploy backup; defaults to false.
- dokploy_
restart bool - Notify on Dokploy restart; defaults to false.
- server_
threshold bool - Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
- volume_
backup bool - Notify on volume backup; defaults to false.
- app
Build BooleanError - Notify on application build error; defaults to false.
- app
Deploy Boolean - Notify on application deployment; defaults to false.
- database
Backup Boolean - Notify on database backup; defaults to false.
- docker
Cleanup Boolean - Notify on Docker cleanup; defaults to false.
- dokploy
Backup Boolean - Notify on Dokploy backup; defaults to false.
- dokploy
Restart Boolean - Notify on Dokploy restart; defaults to false.
- server
Threshold Boolean - Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
- volume
Backup Boolean - Notify on volume backup; defaults to false.
NotificationGotifyConfig, NotificationGotifyConfigArgs
- App
Token string - Secret Gotify application token.
- Server
Url string - Secret Gotify server URL.
- Decoration bool
- Whether to decorate messages; defaults to false.
- Priority int
- Message priority; defaults to 5 (minimum 1).
- App
Token string - Secret Gotify application token.
- Server
Url string - Secret Gotify server URL.
- Decoration bool
- Whether to decorate messages; defaults to false.
- Priority int
- Message priority; defaults to 5 (minimum 1).
- app_
token string - Secret Gotify application token.
- server_
url string - Secret Gotify server URL.
- decoration bool
- Whether to decorate messages; defaults to false.
- priority number
- Message priority; defaults to 5 (minimum 1).
- app
Token String - Secret Gotify application token.
- server
Url String - Secret Gotify server URL.
- decoration Boolean
- Whether to decorate messages; defaults to false.
- priority Integer
- Message priority; defaults to 5 (minimum 1).
- app
Token string - Secret Gotify application token.
- server
Url string - Secret Gotify server URL.
- decoration boolean
- Whether to decorate messages; defaults to false.
- priority number
- Message priority; defaults to 5 (minimum 1).
- app_
token str - Secret Gotify application token.
- server_
url str - Secret Gotify server URL.
- decoration bool
- Whether to decorate messages; defaults to false.
- priority int
- Message priority; defaults to 5 (minimum 1).
- app
Token String - Secret Gotify application token.
- server
Url String - Secret Gotify server URL.
- decoration Boolean
- Whether to decorate messages; defaults to false.
- priority Number
- Message priority; defaults to 5 (minimum 1).
NotificationLarkConfig, NotificationLarkConfigArgs
- Webhook
Url string - Secret Lark webhook URL.
- Webhook
Url string - Secret Lark webhook URL.
- webhook_
url string - Secret Lark webhook URL.
- webhook
Url String - Secret Lark webhook URL.
- webhook
Url string - Secret Lark webhook URL.
- webhook_
url str - Secret Lark webhook URL.
- webhook
Url String - Secret Lark webhook URL.
NotificationMattermostConfig, NotificationMattermostConfigArgs
- Webhook
Url string - Secret Mattermost webhook URL.
- Channel string
- Optional routing channel; defaults to empty.
- Username string
- Optional display username; defaults to empty.
- Webhook
Url string - Secret Mattermost webhook URL.
- Channel string
- Optional routing channel; defaults to empty.
- Username string
- Optional display username; defaults to empty.
- webhook_
url string - Secret Mattermost webhook URL.
- channel string
- Optional routing channel; defaults to empty.
- username string
- Optional display username; defaults to empty.
- webhook
Url String - Secret Mattermost webhook URL.
- channel String
- Optional routing channel; defaults to empty.
- username String
- Optional display username; defaults to empty.
- webhook
Url string - Secret Mattermost webhook URL.
- channel string
- Optional routing channel; defaults to empty.
- username string
- Optional display username; defaults to empty.
- webhook_
url str - Secret Mattermost webhook URL.
- channel str
- Optional routing channel; defaults to empty.
- username str
- Optional display username; defaults to empty.
- webhook
Url String - Secret Mattermost webhook URL.
- channel String
- Optional routing channel; defaults to empty.
- username String
- Optional display username; defaults to empty.
NotificationNtfyConfig, NotificationNtfyConfigArgs
- Server
Url string - Secret Ntfy server URL.
- Topic string
- Ntfy topic.
- Access
Token string - Optional secret access token; defaults to empty.
- Priority int
- Message priority, 1 through 5; defaults to 3.
- Server
Url string - Secret Ntfy server URL.
- Topic string
- Ntfy topic.
- Access
Token string - Optional secret access token; defaults to empty.
- Priority int
- Message priority, 1 through 5; defaults to 3.
- server_
url string - Secret Ntfy server URL.
- topic string
- Ntfy topic.
- access_
token string - Optional secret access token; defaults to empty.
- priority number
- Message priority, 1 through 5; defaults to 3.
- server
Url String - Secret Ntfy server URL.
- topic String
- Ntfy topic.
- access
Token String - Optional secret access token; defaults to empty.
- priority Integer
- Message priority, 1 through 5; defaults to 3.
- server
Url string - Secret Ntfy server URL.
- topic string
- Ntfy topic.
- access
Token string - Optional secret access token; defaults to empty.
- priority number
- Message priority, 1 through 5; defaults to 3.
- server_
url str - Secret Ntfy server URL.
- topic str
- Ntfy topic.
- access_
token str - Optional secret access token; defaults to empty.
- priority int
- Message priority, 1 through 5; defaults to 3.
- server
Url String - Secret Ntfy server URL.
- topic String
- Ntfy topic.
- access
Token String - Optional secret access token; defaults to empty.
- priority Number
- Message priority, 1 through 5; defaults to 3.
NotificationPushoverConfig, NotificationPushoverConfigArgs
- api_
token string - Secret Pushover API token.
- user_
key string - Secret Pushover user key.
- expire number
- Emergency expiry in seconds, 1 through 10800; required for priority 2.
- priority number
- Priority from -2 through 2; defaults to 0.
- retry number
- Emergency retry interval in seconds, at least 30; required for priority 2.
- api
Token String - Secret Pushover API token.
- user
Key String - Secret Pushover user key.
- expire Integer
- Emergency expiry in seconds, 1 through 10800; required for priority 2.
- priority Integer
- Priority from -2 through 2; defaults to 0.
- retry Integer
- Emergency retry interval in seconds, at least 30; required for priority 2.
- api
Token string - Secret Pushover API token.
- user
Key string - Secret Pushover user key.
- expire number
- Emergency expiry in seconds, 1 through 10800; required for priority 2.
- priority number
- Priority from -2 through 2; defaults to 0.
- retry number
- Emergency retry interval in seconds, at least 30; required for priority 2.
- api
Token String - Secret Pushover API token.
- user
Key String - Secret Pushover user key.
- expire Number
- Emergency expiry in seconds, 1 through 10800; required for priority 2.
- priority Number
- Priority from -2 through 2; defaults to 0.
- retry Number
- Emergency retry interval in seconds, at least 30; required for priority 2.
NotificationResendConfig, NotificationResendConfigArgs
- Api
Key string - Secret Resend API key.
- From
Address string - Sender address.
- To
Addresses List<string> - Nonempty list of recipient addresses.
- Api
Key string - Secret Resend API key.
- From
Address string - Sender address.
- To
Addresses []string - Nonempty list of recipient addresses.
- api_
key string - Secret Resend API key.
- from_
address string - Sender address.
- to_
addresses list(string) - Nonempty list of recipient addresses.
- api
Key String - Secret Resend API key.
- from
Address String - Sender address.
- to
Addresses List<String> - Nonempty list of recipient addresses.
- api
Key string - Secret Resend API key.
- from
Address string - Sender address.
- to
Addresses string[] - Nonempty list of recipient addresses.
- api_
key str - Secret Resend API key.
- from_
address str - Sender address.
- to_
addresses Sequence[str] - Nonempty list of recipient addresses.
- api
Key String - Secret Resend API key.
- from
Address String - Sender address.
- to
Addresses List<String> - Nonempty list of recipient addresses.
NotificationSlackConfig, NotificationSlackConfigArgs
- Webhook
Url string - Secret Slack webhook URL.
- Channel string
- Optional routing channel; defaults to empty.
- Webhook
Url string - Secret Slack webhook URL.
- Channel string
- Optional routing channel; defaults to empty.
- webhook_
url string - Secret Slack webhook URL.
- channel string
- Optional routing channel; defaults to empty.
- webhook
Url String - Secret Slack webhook URL.
- channel String
- Optional routing channel; defaults to empty.
- webhook
Url string - Secret Slack webhook URL.
- channel string
- Optional routing channel; defaults to empty.
- webhook_
url str - Secret Slack webhook URL.
- channel str
- Optional routing channel; defaults to empty.
- webhook
Url String - Secret Slack webhook URL.
- channel String
- Optional routing channel; defaults to empty.
NotificationTeamsConfig, NotificationTeamsConfigArgs
- Webhook
Url string - Secret Teams webhook URL.
- Webhook
Url string - Secret Teams webhook URL.
- webhook_
url string - Secret Teams webhook URL.
- webhook
Url String - Secret Teams webhook URL.
- webhook
Url string - Secret Teams webhook URL.
- webhook_
url str - Secret Teams webhook URL.
- webhook
Url String - Secret Teams webhook URL.
NotificationTelegramConfig, NotificationTelegramConfigArgs
- Bot
Token string - Secret Telegram bot token.
- Chat
Id string - Telegram chat ID.
- Message
Thread stringId - Optional message thread ID; defaults to empty.
- Bot
Token string - Secret Telegram bot token.
- Chat
Id string - Telegram chat ID.
- Message
Thread stringId - Optional message thread ID; defaults to empty.
- bot_
token string - Secret Telegram bot token.
- chat_
id string - Telegram chat ID.
- message_
thread_ stringid - Optional message thread ID; defaults to empty.
- bot
Token String - Secret Telegram bot token.
- chat
Id String - Telegram chat ID.
- message
Thread StringId - Optional message thread ID; defaults to empty.
- bot
Token string - Secret Telegram bot token.
- chat
Id string - Telegram chat ID.
- message
Thread stringId - Optional message thread ID; defaults to empty.
- bot_
token str - Secret Telegram bot token.
- chat_
id str - Telegram chat ID.
- message_
thread_ strid - Optional message thread ID; defaults to empty.
- bot
Token String - Secret Telegram bot token.
- chat
Id String - Telegram chat ID.
- message
Thread StringId - Optional message thread ID; defaults to empty.
Package Details
- Repository
- dokploy dimeskigj/pulumi-dokploy
- License
- Apache-2.0
published on Thursday, Nov 5, 2026 by dimeskigj