1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. Notification
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
dokploy logo Dokploy
Viewing docs for Dokploy v0.4.4
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.NotificationCustomConfig
    Custom HTTP destination; select exactly one channel block.
    Discord Dimeskigj.NotificationDiscordConfig
    Discord destination; select exactly one channel block.
    Email Dimeskigj.NotificationEmailConfig
    SMTP email destination; select exactly one channel block.
    Events Dimeskigj.NotificationEvents
    Optional event subscriptions; every omitted event defaults to false.
    Gotify Dimeskigj.NotificationGotifyConfig
    Gotify destination; select exactly one channel block.
    Lark Dimeskigj.NotificationLarkConfig
    Lark destination; select exactly one channel block.
    Mattermost Dimeskigj.NotificationMattermostConfig
    Mattermost destination; select exactly one channel block.
    Ntfy Dimeskigj.NotificationNtfyConfig
    Ntfy destination; select exactly one channel block.
    Pushover Dimeskigj.NotificationPushoverConfig
    Pushover destination; select exactly one channel block.
    Resend Dimeskigj.NotificationResendConfig
    Resend email destination; select exactly one channel block.
    Slack Dimeskigj.NotificationSlackConfig
    Slack destination; select exactly one channel block.
    Teams Dimeskigj.NotificationTeamsConfig
    Teams destination; select exactly one channel block.
    Telegram Dimeskigj.NotificationTelegramConfig
    Telegram destination; select exactly one channel block.
    Name string
    Required notification name.
    Custom NotificationCustomConfigArgs
    Custom HTTP destination; select exactly one channel block.
    Discord NotificationDiscordConfigArgs
    Discord destination; select exactly one channel block.
    Email NotificationEmailConfigArgs
    SMTP email destination; select exactly one channel block.
    Events NotificationEventsArgs
    Optional event subscriptions; every omitted event defaults to false.
    Gotify NotificationGotifyConfigArgs
    Gotify destination; select exactly one channel block.
    Lark NotificationLarkConfigArgs
    Lark destination; select exactly one channel block.
    Mattermost NotificationMattermostConfigArgs
    Mattermost destination; select exactly one channel block.
    Ntfy NotificationNtfyConfigArgs
    Ntfy destination; select exactly one channel block.
    Pushover NotificationPushoverConfigArgs
    Pushover destination; select exactly one channel block.
    Resend NotificationResendConfigArgs
    Resend email destination; select exactly one channel block.
    Slack NotificationSlackConfigArgs
    Slack destination; select exactly one channel block.
    Teams NotificationTeamsConfigArgs
    Teams destination; select exactly one channel block.
    Telegram NotificationTelegramConfigArgs
    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 NotificationCustomConfig
    Custom HTTP destination; select exactly one channel block.
    discord NotificationDiscordConfig
    Discord destination; select exactly one channel block.
    email NotificationEmailConfig
    SMTP email destination; select exactly one channel block.
    events NotificationEvents
    Optional event subscriptions; every omitted event defaults to false.
    gotify NotificationGotifyConfig
    Gotify destination; select exactly one channel block.
    lark NotificationLarkConfig
    Lark destination; select exactly one channel block.
    mattermost NotificationMattermostConfig
    Mattermost destination; select exactly one channel block.
    ntfy NotificationNtfyConfig
    Ntfy destination; select exactly one channel block.
    pushover NotificationPushoverConfig
    Pushover destination; select exactly one channel block.
    resend NotificationResendConfig
    Resend email destination; select exactly one channel block.
    slack NotificationSlackConfig
    Slack destination; select exactly one channel block.
    teams NotificationTeamsConfig
    Teams destination; select exactly one channel block.
    telegram NotificationTelegramConfig
    Telegram destination; select exactly one channel block.
    name string
    Required notification name.
    custom NotificationCustomConfig
    Custom HTTP destination; select exactly one channel block.
    discord NotificationDiscordConfig
    Discord destination; select exactly one channel block.
    email NotificationEmailConfig
    SMTP email destination; select exactly one channel block.
    events NotificationEvents
    Optional event subscriptions; every omitted event defaults to false.
    gotify NotificationGotifyConfig
    Gotify destination; select exactly one channel block.
    lark NotificationLarkConfig
    Lark destination; select exactly one channel block.
    mattermost NotificationMattermostConfig
    Mattermost destination; select exactly one channel block.
    ntfy NotificationNtfyConfig
    Ntfy destination; select exactly one channel block.
    pushover NotificationPushoverConfig
    Pushover destination; select exactly one channel block.
    resend NotificationResendConfig
    Resend email destination; select exactly one channel block.
    slack NotificationSlackConfig
    Slack destination; select exactly one channel block.
    teams NotificationTeamsConfig
    Teams destination; select exactly one channel block.
    telegram NotificationTelegramConfig
    Telegram destination; select exactly one channel block.
    name str
    Required notification name.
    custom NotificationCustomConfigArgs
    Custom HTTP destination; select exactly one channel block.
    discord NotificationDiscordConfigArgs
    Discord destination; select exactly one channel block.
    email NotificationEmailConfigArgs
    SMTP email destination; select exactly one channel block.
    events NotificationEventsArgs
    Optional event subscriptions; every omitted event defaults to false.
    gotify NotificationGotifyConfigArgs
    Gotify destination; select exactly one channel block.
    lark NotificationLarkConfigArgs
    Lark destination; select exactly one channel block.
    mattermost NotificationMattermostConfigArgs
    Mattermost destination; select exactly one channel block.
    ntfy NotificationNtfyConfigArgs
    Ntfy destination; select exactly one channel block.
    pushover NotificationPushoverConfigArgs
    Pushover destination; select exactly one channel block.
    resend NotificationResendConfigArgs
    Resend email destination; select exactly one channel block.
    slack NotificationSlackConfigArgs
    Slack destination; select exactly one channel block.
    teams NotificationTeamsConfigArgs
    Teams destination; select exactly one channel block.
    telegram NotificationTelegramConfigArgs
    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:

    ChannelId string
    Stable selected channel relation ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    NotificationId string
    Stable Dokploy notification ID.
    NotificationType string
    Selected notification channel type.
    OrganizationId string
    Owning Dokploy organization ID.
    ChannelId string
    Stable selected channel relation ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    NotificationId string
    Stable Dokploy notification ID.
    NotificationType string
    Selected notification channel type.
    OrganizationId 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.
    channelId String
    Stable selected channel relation ID.
    id String
    The provider-assigned unique ID for this managed resource.
    notificationId String
    Stable Dokploy notification ID.
    notificationType String
    Selected notification channel type.
    organizationId String
    Owning Dokploy organization ID.
    channelId string
    Stable selected channel relation ID.
    id string
    The provider-assigned unique ID for this managed resource.
    notificationId string
    Stable Dokploy notification ID.
    notificationType string
    Selected notification channel type.
    organizationId 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.
    channelId String
    Stable selected channel relation ID.
    id String
    The provider-assigned unique ID for this managed resource.
    notificationId String
    Stable Dokploy notification ID.
    notificationType String
    Selected notification channel type.
    organizationId 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) -> Notification
    func 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

    Endpoint string
    Secret HTTP(S) destination URL.
    Headers Dictionary<string, string>
    Secret custom HTTP headers; defaults to an empty map.
    Endpoint string
    Secret HTTP(S) destination URL.
    Headers map[string]string
    Secret custom HTTP headers; defaults to an empty map.
    endpoint string
    Secret HTTP(S) destination URL.
    headers map(string)
    Secret custom HTTP headers; defaults to an empty map.
    endpoint String
    Secret HTTP(S) destination URL.
    headers Map<String,String>
    Secret custom HTTP headers; defaults to an empty map.
    endpoint string
    Secret HTTP(S) destination URL.
    headers {[key: string]: string}
    Secret custom HTTP headers; defaults to an empty map.
    endpoint str
    Secret HTTP(S) destination URL.
    headers Mapping[str, str]
    Secret custom HTTP headers; defaults to an empty map.
    endpoint String
    Secret HTTP(S) destination URL.
    headers Map<String>
    Secret custom HTTP headers; defaults to an empty map.

    NotificationDiscordConfig, NotificationDiscordConfigArgs

    WebhookUrl string
    Secret Discord webhook URL.
    Decoration bool
    Whether to decorate messages; defaults to false.
    WebhookUrl 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.
    webhookUrl String
    Secret Discord webhook URL.
    decoration Boolean
    Whether to decorate messages; defaults to false.
    webhookUrl 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.
    webhookUrl String
    Secret Discord webhook URL.
    decoration Boolean
    Whether to decorate messages; defaults to false.

    NotificationEmailConfig, NotificationEmailConfigArgs

    FromAddress string
    Sender address.
    Password string
    Secret SMTP password.
    SmtpPort int
    SMTP port from 1 through 65535.
    SmtpServer string
    SMTP server hostname.
    ToAddresses List<string>
    Nonempty list of recipient addresses.
    Username string
    SMTP username.
    FromAddress string
    Sender address.
    Password string
    Secret SMTP password.
    SmtpPort int
    SMTP port from 1 through 65535.
    SmtpServer string
    SMTP server hostname.
    ToAddresses []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.
    fromAddress String
    Sender address.
    password String
    Secret SMTP password.
    smtpPort Integer
    SMTP port from 1 through 65535.
    smtpServer String
    SMTP server hostname.
    toAddresses List<String>
    Nonempty list of recipient addresses.
    username String
    SMTP username.
    fromAddress string
    Sender address.
    password string
    Secret SMTP password.
    smtpPort number
    SMTP port from 1 through 65535.
    smtpServer string
    SMTP server hostname.
    toAddresses 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.
    fromAddress String
    Sender address.
    password String
    Secret SMTP password.
    smtpPort Number
    SMTP port from 1 through 65535.
    smtpServer String
    SMTP server hostname.
    toAddresses List<String>
    Nonempty list of recipient addresses.
    username String
    SMTP username.

    NotificationEvents, NotificationEventsArgs

    AppBuildError bool
    Notify on application build error; defaults to false.
    AppDeploy bool
    Notify on application deployment; defaults to false.
    DatabaseBackup bool
    Notify on database backup; defaults to false.
    DockerCleanup bool
    Notify on Docker cleanup; defaults to false.
    DokployBackup bool
    Notify on Dokploy backup; defaults to false.
    DokployRestart bool
    Notify on Dokploy restart; defaults to false.
    ServerThreshold bool
    Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
    VolumeBackup bool
    Notify on volume backup; defaults to false.
    AppBuildError bool
    Notify on application build error; defaults to false.
    AppDeploy bool
    Notify on application deployment; defaults to false.
    DatabaseBackup bool
    Notify on database backup; defaults to false.
    DockerCleanup bool
    Notify on Docker cleanup; defaults to false.
    DokployBackup bool
    Notify on Dokploy backup; defaults to false.
    DokployRestart bool
    Notify on Dokploy restart; defaults to false.
    ServerThreshold bool
    Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
    VolumeBackup bool
    Notify on volume backup; defaults to false.
    app_build_error bool
    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.
    appBuildError Boolean
    Notify on application build error; defaults to false.
    appDeploy Boolean
    Notify on application deployment; defaults to false.
    databaseBackup Boolean
    Notify on database backup; defaults to false.
    dockerCleanup Boolean
    Notify on Docker cleanup; defaults to false.
    dokployBackup Boolean
    Notify on Dokploy backup; defaults to false.
    dokployRestart Boolean
    Notify on Dokploy restart; defaults to false.
    serverThreshold Boolean
    Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
    volumeBackup Boolean
    Notify on volume backup; defaults to false.
    appBuildError boolean
    Notify on application build error; defaults to false.
    appDeploy boolean
    Notify on application deployment; defaults to false.
    databaseBackup boolean
    Notify on database backup; defaults to false.
    dockerCleanup boolean
    Notify on Docker cleanup; defaults to false.
    dokployBackup boolean
    Notify on Dokploy backup; defaults to false.
    dokployRestart boolean
    Notify on Dokploy restart; defaults to false.
    serverThreshold boolean
    Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
    volumeBackup boolean
    Notify on volume backup; defaults to false.
    app_build_error bool
    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.
    appBuildError Boolean
    Notify on application build error; defaults to false.
    appDeploy Boolean
    Notify on application deployment; defaults to false.
    databaseBackup Boolean
    Notify on database backup; defaults to false.
    dockerCleanup Boolean
    Notify on Docker cleanup; defaults to false.
    dokployBackup Boolean
    Notify on Dokploy backup; defaults to false.
    dokployRestart Boolean
    Notify on Dokploy restart; defaults to false.
    serverThreshold Boolean
    Notify on server threshold; unsupported for Gotify and Ntfy; defaults to false.
    volumeBackup Boolean
    Notify on volume backup; defaults to false.

    NotificationGotifyConfig, NotificationGotifyConfigArgs

    AppToken string
    Secret Gotify application token.
    ServerUrl string
    Secret Gotify server URL.
    Decoration bool
    Whether to decorate messages; defaults to false.
    Priority int
    Message priority; defaults to 5 (minimum 1).
    AppToken string
    Secret Gotify application token.
    ServerUrl 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).
    appToken String
    Secret Gotify application token.
    serverUrl String
    Secret Gotify server URL.
    decoration Boolean
    Whether to decorate messages; defaults to false.
    priority Integer
    Message priority; defaults to 5 (minimum 1).
    appToken string
    Secret Gotify application token.
    serverUrl 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).
    appToken String
    Secret Gotify application token.
    serverUrl 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

    WebhookUrl string
    Secret Lark webhook URL.
    WebhookUrl string
    Secret Lark webhook URL.
    webhook_url string
    Secret Lark webhook URL.
    webhookUrl String
    Secret Lark webhook URL.
    webhookUrl string
    Secret Lark webhook URL.
    webhook_url str
    Secret Lark webhook URL.
    webhookUrl String
    Secret Lark webhook URL.

    NotificationMattermostConfig, NotificationMattermostConfigArgs

    WebhookUrl string
    Secret Mattermost webhook URL.
    Channel string
    Optional routing channel; defaults to empty.
    Username string
    Optional display username; defaults to empty.
    WebhookUrl 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.
    webhookUrl String
    Secret Mattermost webhook URL.
    channel String
    Optional routing channel; defaults to empty.
    username String
    Optional display username; defaults to empty.
    webhookUrl 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.
    webhookUrl String
    Secret Mattermost webhook URL.
    channel String
    Optional routing channel; defaults to empty.
    username String
    Optional display username; defaults to empty.

    NotificationNtfyConfig, NotificationNtfyConfigArgs

    ServerUrl string
    Secret Ntfy server URL.
    Topic string
    Ntfy topic.
    AccessToken string
    Optional secret access token; defaults to empty.
    Priority int
    Message priority, 1 through 5; defaults to 3.
    ServerUrl string
    Secret Ntfy server URL.
    Topic string
    Ntfy topic.
    AccessToken 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.
    serverUrl String
    Secret Ntfy server URL.
    topic String
    Ntfy topic.
    accessToken String
    Optional secret access token; defaults to empty.
    priority Integer
    Message priority, 1 through 5; defaults to 3.
    serverUrl string
    Secret Ntfy server URL.
    topic string
    Ntfy topic.
    accessToken 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.
    serverUrl String
    Secret Ntfy server URL.
    topic String
    Ntfy topic.
    accessToken String
    Optional secret access token; defaults to empty.
    priority Number
    Message priority, 1 through 5; defaults to 3.

    NotificationPushoverConfig, NotificationPushoverConfigArgs

    ApiToken string
    Secret Pushover API token.
    UserKey string
    Secret Pushover user key.
    Expire int
    Emergency expiry in seconds, 1 through 10800; required for priority 2.
    Priority int
    Priority from -2 through 2; defaults to 0.
    Retry int
    Emergency retry interval in seconds, at least 30; required for priority 2.
    ApiToken string
    Secret Pushover API token.
    UserKey string
    Secret Pushover user key.
    Expire int
    Emergency expiry in seconds, 1 through 10800; required for priority 2.
    Priority int
    Priority from -2 through 2; defaults to 0.
    Retry int
    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.
    apiToken String
    Secret Pushover API token.
    userKey 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.
    apiToken string
    Secret Pushover API token.
    userKey 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 str
    Secret Pushover API token.
    user_key str
    Secret Pushover user key.
    expire int
    Emergency expiry in seconds, 1 through 10800; required for priority 2.
    priority int
    Priority from -2 through 2; defaults to 0.
    retry int
    Emergency retry interval in seconds, at least 30; required for priority 2.
    apiToken String
    Secret Pushover API token.
    userKey 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

    ApiKey string
    Secret Resend API key.
    FromAddress string
    Sender address.
    ToAddresses List<string>
    Nonempty list of recipient addresses.
    ApiKey string
    Secret Resend API key.
    FromAddress string
    Sender address.
    ToAddresses []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.
    apiKey String
    Secret Resend API key.
    fromAddress String
    Sender address.
    toAddresses List<String>
    Nonempty list of recipient addresses.
    apiKey string
    Secret Resend API key.
    fromAddress string
    Sender address.
    toAddresses 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.
    apiKey String
    Secret Resend API key.
    fromAddress String
    Sender address.
    toAddresses List<String>
    Nonempty list of recipient addresses.

    NotificationSlackConfig, NotificationSlackConfigArgs

    WebhookUrl string
    Secret Slack webhook URL.
    Channel string
    Optional routing channel; defaults to empty.
    WebhookUrl 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.
    webhookUrl String
    Secret Slack webhook URL.
    channel String
    Optional routing channel; defaults to empty.
    webhookUrl 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.
    webhookUrl String
    Secret Slack webhook URL.
    channel String
    Optional routing channel; defaults to empty.

    NotificationTeamsConfig, NotificationTeamsConfigArgs

    WebhookUrl string
    Secret Teams webhook URL.
    WebhookUrl string
    Secret Teams webhook URL.
    webhook_url string
    Secret Teams webhook URL.
    webhookUrl String
    Secret Teams webhook URL.
    webhookUrl string
    Secret Teams webhook URL.
    webhook_url str
    Secret Teams webhook URL.
    webhookUrl String
    Secret Teams webhook URL.

    NotificationTelegramConfig, NotificationTelegramConfigArgs

    BotToken string
    Secret Telegram bot token.
    ChatId string
    Telegram chat ID.
    MessageThreadId string
    Optional message thread ID; defaults to empty.
    BotToken string
    Secret Telegram bot token.
    ChatId string
    Telegram chat ID.
    MessageThreadId string
    Optional message thread ID; defaults to empty.
    bot_token string
    Secret Telegram bot token.
    chat_id string
    Telegram chat ID.
    message_thread_id string
    Optional message thread ID; defaults to empty.
    botToken String
    Secret Telegram bot token.
    chatId String
    Telegram chat ID.
    messageThreadId String
    Optional message thread ID; defaults to empty.
    botToken string
    Secret Telegram bot token.
    chatId string
    Telegram chat ID.
    messageThreadId string
    Optional message thread ID; defaults to empty.
    bot_token str
    Secret Telegram bot token.
    chat_id str
    Telegram chat ID.
    message_thread_id str
    Optional message thread ID; defaults to empty.
    botToken String
    Secret Telegram bot token.
    chatId String
    Telegram chat ID.
    messageThreadId String
    Optional message thread ID; defaults to empty.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.4.4
    published on Thursday, Nov 5, 2026 by dimeskigj

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial