1. Registry
  2. Packages
  3. Oh Dear
  4. API Docs
  5. NotificationDestination
Viewing docs for Oh Dear v1.0.0
published on Tuesday, Sep 1, 2026 by Matthias Hamacher
ohdear logo
Viewing docs for Oh Dear v1.0.0
published on Tuesday, Sep 1, 2026 by Matthias Hamacher

    An Oh Dear notification destination for a team, monitor, tag or tag group.

    Create NotificationDestination Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NotificationDestination(name: string, args: NotificationDestinationArgs, opts?: CustomResourceOptions);
    @overload
    def NotificationDestination(resource_name: str,
                                args: NotificationDestinationArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def NotificationDestination(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                channel: Optional[str] = None,
                                destination: Optional[Mapping[str, str]] = None,
                                level: Optional[str] = None,
                                owner_id: Optional[int] = None,
                                enabled: Optional[bool] = None,
                                label: Optional[str] = None,
                                notification_types: Optional[Sequence[str]] = None)
    func NewNotificationDestination(ctx *Context, name string, args NotificationDestinationArgs, opts ...ResourceOption) (*NotificationDestination, error)
    public NotificationDestination(string name, NotificationDestinationArgs args, CustomResourceOptions? opts = null)
    public NotificationDestination(String name, NotificationDestinationArgs args)
    public NotificationDestination(String name, NotificationDestinationArgs args, CustomResourceOptions options)
    
    type: ohdear:NotificationDestination
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "ohdear_notification_destination" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args NotificationDestinationArgs
    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 NotificationDestinationArgs
    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 NotificationDestinationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationDestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationDestinationArgs
    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 notificationDestinationResource = new Ohdear.NotificationDestination("notificationDestinationResource", new()
    {
        Channel = "string",
        Destination = 
        {
            { "string", "string" },
        },
        Level = "string",
        OwnerId = 0,
        Enabled = false,
        Label = "string",
        NotificationTypes = new[]
        {
            "string",
        },
    });
    
    example, err := ohdear.NewNotificationDestination(ctx, "notificationDestinationResource", &ohdear.NotificationDestinationArgs{
    	Channel: pulumi.String("string"),
    	Destination: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Level:   pulumi.String("string"),
    	OwnerId: pulumi.Int(0),
    	Enabled: pulumi.Bool(false),
    	Label:   pulumi.String("string"),
    	NotificationTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "ohdear_notification_destination" "notificationDestinationResource" {
      pulumi {
        replace_on_changes = [level, owner_id]
      }
      lifecycle {
        create_before_destroy = true
      }
      channel = "string"
      destination = {
        "string" = "string"
      }
      level              = "string"
      owner_id           = 0
      enabled            = false
      label              = "string"
      notification_types = ["string"]
    }
    
    var notificationDestinationResource = new NotificationDestination("notificationDestinationResource", NotificationDestinationArgs.builder()
        .channel("string")
        .destination(Map.of("string", "string"))
        .level("string")
        .ownerId(0)
        .enabled(false)
        .label("string")
        .notificationTypes("string")
        .build());
    
    notification_destination_resource = ohdear.NotificationDestination("notificationDestinationResource",
        channel="string",
        destination={
            "string": "string",
        },
        level="string",
        owner_id=0,
        enabled=False,
        label="string",
        notification_types=["string"])
    
    const notificationDestinationResource = new ohdear.NotificationDestination("notificationDestinationResource", {
        channel: "string",
        destination: {
            string: "string",
        },
        level: "string",
        ownerId: 0,
        enabled: false,
        label: "string",
        notificationTypes: ["string"],
    });
    
    type: ohdear:NotificationDestination
    properties:
        channel: string
        destination:
            string: string
        enabled: false
        label: string
        level: string
        notificationTypes:
            - string
        ownerId: 0
    

    NotificationDestination 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 NotificationDestination resource accepts the following input properties:

    Channel string
    Notification channel, e.g. "mail", "slack", "discord", "webhook".
    Destination Dictionary<string, string>
    Channel-specific settings, e.g. { url: ... } for a webhook, { channel: ... } for Slack. Values are strings; use "true"/"false" for booleans such as Opsgenie's euEndpoint. Secret; kept from inputs on refresh.
    Level string
    Owner type: "team", "monitor", "tag" or "tagGroup".
    OwnerId int
    ID of the owning team, monitor, tag or tag group.
    Enabled bool
    Whether the destination is active. Default true; toggled via the enable/disable endpoints.
    Label string
    Display label for the destination.
    NotificationTypes List<string>
    Event types that trigger a notification (uptime, certificate_health, ...). Empty means all.
    Channel string
    Notification channel, e.g. "mail", "slack", "discord", "webhook".
    Destination map[string]string
    Channel-specific settings, e.g. { url: ... } for a webhook, { channel: ... } for Slack. Values are strings; use "true"/"false" for booleans such as Opsgenie's euEndpoint. Secret; kept from inputs on refresh.
    Level string
    Owner type: "team", "monitor", "tag" or "tagGroup".
    OwnerId int
    ID of the owning team, monitor, tag or tag group.
    Enabled bool
    Whether the destination is active. Default true; toggled via the enable/disable endpoints.
    Label string
    Display label for the destination.
    NotificationTypes []string
    Event types that trigger a notification (uptime, certificate_health, ...). Empty means all.
    channel string
    Notification channel, e.g. "mail", "slack", "discord", "webhook".
    destination map(string)
    Channel-specific settings, e.g. { url: ... } for a webhook, { channel: ... } for Slack. Values are strings; use "true"/"false" for booleans such as Opsgenie's euEndpoint. Secret; kept from inputs on refresh.
    level string
    Owner type: "team", "monitor", "tag" or "tagGroup".
    owner_id number
    ID of the owning team, monitor, tag or tag group.
    enabled bool
    Whether the destination is active. Default true; toggled via the enable/disable endpoints.
    label string
    Display label for the destination.
    notification_types list(string)
    Event types that trigger a notification (uptime, certificate_health, ...). Empty means all.
    channel String
    Notification channel, e.g. "mail", "slack", "discord", "webhook".
    destination Map<String,String>
    Channel-specific settings, e.g. { url: ... } for a webhook, { channel: ... } for Slack. Values are strings; use "true"/"false" for booleans such as Opsgenie's euEndpoint. Secret; kept from inputs on refresh.
    level String
    Owner type: "team", "monitor", "tag" or "tagGroup".
    ownerId Integer
    ID of the owning team, monitor, tag or tag group.
    enabled Boolean
    Whether the destination is active. Default true; toggled via the enable/disable endpoints.
    label String
    Display label for the destination.
    notificationTypes List<String>
    Event types that trigger a notification (uptime, certificate_health, ...). Empty means all.
    channel string
    Notification channel, e.g. "mail", "slack", "discord", "webhook".
    destination {[key: string]: string}
    Channel-specific settings, e.g. { url: ... } for a webhook, { channel: ... } for Slack. Values are strings; use "true"/"false" for booleans such as Opsgenie's euEndpoint. Secret; kept from inputs on refresh.
    level string
    Owner type: "team", "monitor", "tag" or "tagGroup".
    ownerId number
    ID of the owning team, monitor, tag or tag group.
    enabled boolean
    Whether the destination is active. Default true; toggled via the enable/disable endpoints.
    label string
    Display label for the destination.
    notificationTypes string[]
    Event types that trigger a notification (uptime, certificate_health, ...). Empty means all.
    channel str
    Notification channel, e.g. "mail", "slack", "discord", "webhook".
    destination Mapping[str, str]
    Channel-specific settings, e.g. { url: ... } for a webhook, { channel: ... } for Slack. Values are strings; use "true"/"false" for booleans such as Opsgenie's euEndpoint. Secret; kept from inputs on refresh.
    level str
    Owner type: "team", "monitor", "tag" or "tagGroup".
    owner_id int
    ID of the owning team, monitor, tag or tag group.
    enabled bool
    Whether the destination is active. Default true; toggled via the enable/disable endpoints.
    label str
    Display label for the destination.
    notification_types Sequence[str]
    Event types that trigger a notification (uptime, certificate_health, ...). Empty means all.
    channel String
    Notification channel, e.g. "mail", "slack", "discord", "webhook".
    destination Map<String>
    Channel-specific settings, e.g. { url: ... } for a webhook, { channel: ... } for Slack. Values are strings; use "true"/"false" for booleans such as Opsgenie's euEndpoint. Secret; kept from inputs on refresh.
    level String
    Owner type: "team", "monitor", "tag" or "tagGroup".
    ownerId Number
    ID of the owning team, monitor, tag or tag group.
    enabled Boolean
    Whether the destination is active. Default true; toggled via the enable/disable endpoints.
    label String
    Display label for the destination.
    notificationTypes List<String>
    Event types that trigger a notification (uptime, certificate_health, ...). Empty means all.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NotificationDestination resource produces the following output properties:

    DestinationId int
    Numeric Oh Dear notification destination ID.
    DisabledReason string
    Why Oh Dear disabled the destination, if it did (e.g. repeated delivery failures).
    Id string
    The provider-assigned unique ID for this managed resource.
    DestinationId int
    Numeric Oh Dear notification destination ID.
    DisabledReason string
    Why Oh Dear disabled the destination, if it did (e.g. repeated delivery failures).
    Id string
    The provider-assigned unique ID for this managed resource.
    destination_id number
    Numeric Oh Dear notification destination ID.
    disabled_reason string
    Why Oh Dear disabled the destination, if it did (e.g. repeated delivery failures).
    id string
    The provider-assigned unique ID for this managed resource.
    destinationId Integer
    Numeric Oh Dear notification destination ID.
    disabledReason String
    Why Oh Dear disabled the destination, if it did (e.g. repeated delivery failures).
    id String
    The provider-assigned unique ID for this managed resource.
    destinationId number
    Numeric Oh Dear notification destination ID.
    disabledReason string
    Why Oh Dear disabled the destination, if it did (e.g. repeated delivery failures).
    id string
    The provider-assigned unique ID for this managed resource.
    destination_id int
    Numeric Oh Dear notification destination ID.
    disabled_reason str
    Why Oh Dear disabled the destination, if it did (e.g. repeated delivery failures).
    id str
    The provider-assigned unique ID for this managed resource.
    destinationId Number
    Numeric Oh Dear notification destination ID.
    disabledReason String
    Why Oh Dear disabled the destination, if it did (e.g. repeated delivery failures).
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    ohdear matthiashamacher/pulumi-ohdear
    License
    Apache-2.0
    ohdear logo
    Viewing docs for Oh Dear v1.0.0
    published on Tuesday, Sep 1, 2026 by Matthias Hamacher

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial