1. Packages
  2. Checkly
  3. API Docs
  4. HeartbeatCheck
Checkly v2.7.0 published on Tuesday, Nov 4, 2025 by Checkly
checkly/pulumi-checkly

checkly.HeartbeatCheck

Get Started
checkly logo
Checkly v2.7.0 published on Tuesday, Nov 4, 2025 by Checkly
checkly/pulumi-checkly

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@checkly/pulumi";

const example_heartbeat = new checkly.HeartbeatCheck("example-heartbeat", {
    name: "Example heartbeat",
    activated: true,
    heartbeat: {
        period: 7,
        periodUnit: "days",
        grace: 1,
        graceUnit: "days",
    },
    useGlobalAlertSettings: true,
});

    import pulumi
import pulumi_checkly as checkly

example_heartbeat = checkly.HeartbeatCheck("example-heartbeat",
    name="Example heartbeat",
    activated=True,
    heartbeat={
        "period": 7,
        "period_unit": "days",
        "grace": 1,
        "grace_unit": "days",
    },
    use_global_alert_settings=True)

    package main

import (
	"github.com/checkly/pulumi-checkly/sdk/v2/go/checkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewHeartbeatCheck(ctx, "example-heartbeat", &checkly.HeartbeatCheckArgs{
			Name:      pulumi.String("Example heartbeat"),
			Activated: pulumi.Bool(true),
			Heartbeat: &checkly.HeartbeatCheckHeartbeatArgs{
				Period:     pulumi.Int(7),
				PeriodUnit: pulumi.String("days"),
				Grace:      pulumi.Int(1),
				GraceUnit:  pulumi.String("days"),
			},
			UseGlobalAlertSettings: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkly = Pulumi.Checkly;

return await Deployment.RunAsync(() => 
{
    var example_heartbeat = new Checkly.HeartbeatCheck("example-heartbeat", new()
    {
        Name = "Example heartbeat",
        Activated = true,
        Heartbeat = new Checkly.Inputs.HeartbeatCheckHeartbeatArgs
        {
            Period = 7,
            PeriodUnit = "days",
            Grace = 1,
            GraceUnit = "days",
        },
        UseGlobalAlertSettings = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.HeartbeatCheck;
import com.pulumi.checkly.HeartbeatCheckArgs;
import com.pulumi.checkly.inputs.HeartbeatCheckHeartbeatArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example_heartbeat = new HeartbeatCheck("example-heartbeat", HeartbeatCheckArgs.builder()
            .name("Example heartbeat")
            .activated(true)
            .heartbeat(HeartbeatCheckHeartbeatArgs.builder()
                .period(7)
                .periodUnit("days")
                .grace(1)
                .graceUnit("days")
                .build())
            .useGlobalAlertSettings(true)
            .build());

    }
}

    resources:
  example-heartbeat:
    type: checkly:HeartbeatCheck
    properties:
      name: Example heartbeat
      activated: true
      heartbeat:
        period: 7
        periodUnit: days
        grace: 1
        graceUnit: days
      useGlobalAlertSettings: true

    Create HeartbeatCheck Resource

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

    Constructor syntax

    new HeartbeatCheck(name: string, args: HeartbeatCheckArgs, opts?: CustomResourceOptions);
    @overload
def HeartbeatCheck(resource_name: str,
                   args: HeartbeatCheckArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def HeartbeatCheck(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   activated: Optional[bool] = None,
                   heartbeat: Optional[HeartbeatCheckHeartbeatArgs] = None,
                   alert_channel_subscriptions: Optional[Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]] = None,
                   alert_settings: Optional[HeartbeatCheckAlertSettingsArgs] = None,
                   muted: Optional[bool] = None,
                   name: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None,
                   trigger_incident: Optional[HeartbeatCheckTriggerIncidentArgs] = None,
                   use_global_alert_settings: Optional[bool] = None)
    func NewHeartbeatCheck(ctx *Context, name string, args HeartbeatCheckArgs, opts ...ResourceOption) (*HeartbeatCheck, error)
    public HeartbeatCheck(string name, HeartbeatCheckArgs args, CustomResourceOptions? opts = null)
    public HeartbeatCheck(String name, HeartbeatCheckArgs args)
public HeartbeatCheck(String name, HeartbeatCheckArgs args, CustomResourceOptions options)

    type: checkly:HeartbeatCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args HeartbeatCheckArgs
    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 HeartbeatCheckArgs
    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 HeartbeatCheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HeartbeatCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HeartbeatCheckArgs
    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 heartbeatCheckResource = new Checkly.HeartbeatCheck("heartbeatCheckResource", new()
{
    Activated = false,
    Heartbeat = new Checkly.Inputs.HeartbeatCheckHeartbeatArgs
    {
        Grace = 0,
        GraceUnit = "string",
        Period = 0,
        PeriodUnit = "string",
        PingToken = "string",
    },
    AlertChannelSubscriptions = new[]
    {
        new Checkly.Inputs.HeartbeatCheckAlertChannelSubscriptionArgs
        {
            Activated = false,
            ChannelId = 0,
        },
    },
    AlertSettings = new Checkly.Inputs.HeartbeatCheckAlertSettingsArgs
    {
        EscalationType = "string",
        ParallelRunFailureThresholds = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs
            {
                Enabled = false,
                Percentage = 0,
            },
        },
        Reminders = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsReminderArgs
            {
                Amount = 0,
                Interval = 0,
            },
        },
        RunBasedEscalations = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsRunBasedEscalationArgs
            {
                FailedRunThreshold = 0,
            },
        },
        TimeBasedEscalations = new[]
        {
            new Checkly.Inputs.HeartbeatCheckAlertSettingsTimeBasedEscalationArgs
            {
                MinutesFailingThreshold = 0,
            },
        },
    },
    Muted = false,
    Name = "string",
    Tags = new[]
    {
        "string",
    },
    TriggerIncident = new Checkly.Inputs.HeartbeatCheckTriggerIncidentArgs
    {
        Description = "string",
        Name = "string",
        NotifySubscribers = false,
        ServiceId = "string",
        Severity = "string",
    },
    UseGlobalAlertSettings = false,
});

    example, err := checkly.NewHeartbeatCheck(ctx, "heartbeatCheckResource", &checkly.HeartbeatCheckArgs{
	Activated: pulumi.Bool(false),
	Heartbeat: &checkly.HeartbeatCheckHeartbeatArgs{
		Grace:      pulumi.Int(0),
		GraceUnit:  pulumi.String("string"),
		Period:     pulumi.Int(0),
		PeriodUnit: pulumi.String("string"),
		PingToken:  pulumi.String("string"),
	},
	AlertChannelSubscriptions: checkly.HeartbeatCheckAlertChannelSubscriptionArray{
		&checkly.HeartbeatCheckAlertChannelSubscriptionArgs{
			Activated: pulumi.Bool(false),
			ChannelId: pulumi.Int(0),
		},
	},
	AlertSettings: &checkly.HeartbeatCheckAlertSettingsArgs{
		EscalationType: pulumi.String("string"),
		ParallelRunFailureThresholds: checkly.HeartbeatCheckAlertSettingsParallelRunFailureThresholdArray{
			&checkly.HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs{
				Enabled:    pulumi.Bool(false),
				Percentage: pulumi.Int(0),
			},
		},
		Reminders: checkly.HeartbeatCheckAlertSettingsReminderArray{
			&checkly.HeartbeatCheckAlertSettingsReminderArgs{
				Amount:   pulumi.Int(0),
				Interval: pulumi.Int(0),
			},
		},
		RunBasedEscalations: checkly.HeartbeatCheckAlertSettingsRunBasedEscalationArray{
			&checkly.HeartbeatCheckAlertSettingsRunBasedEscalationArgs{
				FailedRunThreshold: pulumi.Int(0),
			},
		},
		TimeBasedEscalations: checkly.HeartbeatCheckAlertSettingsTimeBasedEscalationArray{
			&checkly.HeartbeatCheckAlertSettingsTimeBasedEscalationArgs{
				MinutesFailingThreshold: pulumi.Int(0),
			},
		},
	},
	Muted: pulumi.Bool(false),
	Name:  pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TriggerIncident: &checkly.HeartbeatCheckTriggerIncidentArgs{
		Description:       pulumi.String("string"),
		Name:              pulumi.String("string"),
		NotifySubscribers: pulumi.Bool(false),
		ServiceId:         pulumi.String("string"),
		Severity:          pulumi.String("string"),
	},
	UseGlobalAlertSettings: pulumi.Bool(false),
})

    var heartbeatCheckResource = new HeartbeatCheck("heartbeatCheckResource", HeartbeatCheckArgs.builder()
    .activated(false)
    .heartbeat(HeartbeatCheckHeartbeatArgs.builder()
        .grace(0)
        .graceUnit("string")
        .period(0)
        .periodUnit("string")
        .pingToken("string")
        .build())
    .alertChannelSubscriptions(HeartbeatCheckAlertChannelSubscriptionArgs.builder()
        .activated(false)
        .channelId(0)
        .build())
    .alertSettings(HeartbeatCheckAlertSettingsArgs.builder()
        .escalationType("string")
        .parallelRunFailureThresholds(HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs.builder()
            .enabled(false)
            .percentage(0)
            .build())
        .reminders(HeartbeatCheckAlertSettingsReminderArgs.builder()
            .amount(0)
            .interval(0)
            .build())
        .runBasedEscalations(HeartbeatCheckAlertSettingsRunBasedEscalationArgs.builder()
            .failedRunThreshold(0)
            .build())
        .timeBasedEscalations(HeartbeatCheckAlertSettingsTimeBasedEscalationArgs.builder()
            .minutesFailingThreshold(0)
            .build())
        .build())
    .muted(false)
    .name("string")
    .tags("string")
    .triggerIncident(HeartbeatCheckTriggerIncidentArgs.builder()
        .description("string")
        .name("string")
        .notifySubscribers(false)
        .serviceId("string")
        .severity("string")
        .build())
    .useGlobalAlertSettings(false)
    .build());

    heartbeat_check_resource = checkly.HeartbeatCheck("heartbeatCheckResource",
    activated=False,
    heartbeat={
        "grace": 0,
        "grace_unit": "string",
        "period": 0,
        "period_unit": "string",
        "ping_token": "string",
    },
    alert_channel_subscriptions=[{
        "activated": False,
        "channel_id": 0,
    }],
    alert_settings={
        "escalation_type": "string",
        "parallel_run_failure_thresholds": [{
            "enabled": False,
            "percentage": 0,
        }],
        "reminders": [{
            "amount": 0,
            "interval": 0,
        }],
        "run_based_escalations": [{
            "failed_run_threshold": 0,
        }],
        "time_based_escalations": [{
            "minutes_failing_threshold": 0,
        }],
    },
    muted=False,
    name="string",
    tags=["string"],
    trigger_incident={
        "description": "string",
        "name": "string",
        "notify_subscribers": False,
        "service_id": "string",
        "severity": "string",
    },
    use_global_alert_settings=False)

    const heartbeatCheckResource = new checkly.HeartbeatCheck("heartbeatCheckResource", {
    activated: false,
    heartbeat: {
        grace: 0,
        graceUnit: "string",
        period: 0,
        periodUnit: "string",
        pingToken: "string",
    },
    alertChannelSubscriptions: [{
        activated: false,
        channelId: 0,
    }],
    alertSettings: {
        escalationType: "string",
        parallelRunFailureThresholds: [{
            enabled: false,
            percentage: 0,
        }],
        reminders: [{
            amount: 0,
            interval: 0,
        }],
        runBasedEscalations: [{
            failedRunThreshold: 0,
        }],
        timeBasedEscalations: [{
            minutesFailingThreshold: 0,
        }],
    },
    muted: false,
    name: "string",
    tags: ["string"],
    triggerIncident: {
        description: "string",
        name: "string",
        notifySubscribers: false,
        serviceId: "string",
        severity: "string",
    },
    useGlobalAlertSettings: false,
});

    type: checkly:HeartbeatCheck
properties:
    activated: false
    alertChannelSubscriptions:
        - activated: false
          channelId: 0
    alertSettings:
        escalationType: string
        parallelRunFailureThresholds:
            - enabled: false
              percentage: 0
        reminders:
            - amount: 0
              interval: 0
        runBasedEscalations:
            - failedRunThreshold: 0
        timeBasedEscalations:
            - minutesFailingThreshold: 0
    heartbeat:
        grace: 0
        graceUnit: string
        period: 0
        periodUnit: string
        pingToken: string
    muted: false
    name: string
    tags:
        - string
    triggerIncident:
        description: string
        name: string
        notifySubscribers: false
        serviceId: string
        severity: string
    useGlobalAlertSettings: false

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

    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    Heartbeat HeartbeatCheckHeartbeat
    AlertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
    AlertSettings HeartbeatCheckAlertSettings
    Determines the alert escalation policy for the monitor.
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    Tags List<string>
    A list of tags for organizing and filtering checks.
    TriggerIncident HeartbeatCheckTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    Heartbeat HeartbeatCheckHeartbeatArgs
    AlertChannelSubscriptions []HeartbeatCheckAlertChannelSubscriptionArgs
    AlertSettings HeartbeatCheckAlertSettingsArgs
    Determines the alert escalation policy for the monitor.
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    Tags []string
    A list of tags for organizing and filtering checks.
    TriggerIncident HeartbeatCheckTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    heartbeat HeartbeatCheckHeartbeat
    alertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
    alertSettings HeartbeatCheckAlertSettings
    Determines the alert escalation policy for the monitor.
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    tags List<String>
    A list of tags for organizing and filtering checks.
    triggerIncident HeartbeatCheckTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated boolean
    Determines if the check is running or not. Possible values true, and false.
    heartbeat HeartbeatCheckHeartbeat
    alertChannelSubscriptions HeartbeatCheckAlertChannelSubscription[]
    alertSettings HeartbeatCheckAlertSettings
    Determines the alert escalation policy for the monitor.
    muted boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name string
    The name of the check.
    tags string[]
    A list of tags for organizing and filtering checks.
    triggerIncident HeartbeatCheckTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated bool
    Determines if the check is running or not. Possible values true, and false.
    heartbeat HeartbeatCheckHeartbeatArgs
    alert_channel_subscriptions Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]
    alert_settings HeartbeatCheckAlertSettingsArgs
    Determines the alert escalation policy for the monitor.
    muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name str
    The name of the check.
    tags Sequence[str]
    A list of tags for organizing and filtering checks.
    trigger_incident HeartbeatCheckTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    heartbeat Property Map
    alertChannelSubscriptions List<Property Map>
    alertSettings Property Map
    Determines the alert escalation policy for the monitor.
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    tags List<String>
    A list of tags for organizing and filtering checks.
    triggerIncident Property Map
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing HeartbeatCheck Resource

    Get an existing HeartbeatCheck 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>, state?: HeartbeatCheckState, opts?: CustomResourceOptions): HeartbeatCheck
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activated: Optional[bool] = None,
        alert_channel_subscriptions: Optional[Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]] = None,
        alert_settings: Optional[HeartbeatCheckAlertSettingsArgs] = None,
        heartbeat: Optional[HeartbeatCheckHeartbeatArgs] = None,
        muted: Optional[bool] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        trigger_incident: Optional[HeartbeatCheckTriggerIncidentArgs] = None,
        use_global_alert_settings: Optional[bool] = None) -> HeartbeatCheck
    func GetHeartbeatCheck(ctx *Context, name string, id IDInput, state *HeartbeatCheckState, opts ...ResourceOption) (*HeartbeatCheck, error)
    public static HeartbeatCheck Get(string name, Input<string> id, HeartbeatCheckState? state, CustomResourceOptions? opts = null)
    public static HeartbeatCheck get(String name, Output<String> id, HeartbeatCheckState state, CustomResourceOptions options)
    resources:  _:    type: checkly:HeartbeatCheck    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    AlertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
    AlertSettings HeartbeatCheckAlertSettings
    Determines the alert escalation policy for the monitor.
    Heartbeat HeartbeatCheckHeartbeat
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    Tags List<string>
    A list of tags for organizing and filtering checks.
    TriggerIncident HeartbeatCheckTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    AlertChannelSubscriptions []HeartbeatCheckAlertChannelSubscriptionArgs
    AlertSettings HeartbeatCheckAlertSettingsArgs
    Determines the alert escalation policy for the monitor.
    Heartbeat HeartbeatCheckHeartbeatArgs
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    Tags []string
    A list of tags for organizing and filtering checks.
    TriggerIncident HeartbeatCheckTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    alertChannelSubscriptions List<HeartbeatCheckAlertChannelSubscription>
    alertSettings HeartbeatCheckAlertSettings
    Determines the alert escalation policy for the monitor.
    heartbeat HeartbeatCheckHeartbeat
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    tags List<String>
    A list of tags for organizing and filtering checks.
    triggerIncident HeartbeatCheckTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated boolean
    Determines if the check is running or not. Possible values true, and false.
    alertChannelSubscriptions HeartbeatCheckAlertChannelSubscription[]
    alertSettings HeartbeatCheckAlertSettings
    Determines the alert escalation policy for the monitor.
    heartbeat HeartbeatCheckHeartbeat
    muted boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name string
    The name of the check.
    tags string[]
    A list of tags for organizing and filtering checks.
    triggerIncident HeartbeatCheckTriggerIncident
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated bool
    Determines if the check is running or not. Possible values true, and false.
    alert_channel_subscriptions Sequence[HeartbeatCheckAlertChannelSubscriptionArgs]
    alert_settings HeartbeatCheckAlertSettingsArgs
    Determines the alert escalation policy for the monitor.
    heartbeat HeartbeatCheckHeartbeatArgs
    muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name str
    The name of the check.
    tags Sequence[str]
    A list of tags for organizing and filtering checks.
    trigger_incident HeartbeatCheckTriggerIncidentArgs
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    alertChannelSubscriptions List<Property Map>
    alertSettings Property Map
    Determines the alert escalation policy for the monitor.
    heartbeat Property Map
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    tags List<String>
    A list of tags for organizing and filtering checks.
    triggerIncident Property Map
    Create and resolve an incident based on the alert configuration. Useful for status page automation.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Supporting Types

    HeartbeatCheckAlertChannelSubscription, HeartbeatCheckAlertChannelSubscriptionArgs

    activated Boolean
    channelId Integer
    activated boolean
    channelId number
    activated Boolean
    channelId Number

    HeartbeatCheckAlertSettings, HeartbeatCheckAlertSettingsArgs

    EscalationType string
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    ParallelRunFailureThresholds List<HeartbeatCheckAlertSettingsParallelRunFailureThreshold>
    Configuration for parallel run failure threshold.
    Reminders List<HeartbeatCheckAlertSettingsReminder>
    Defines how often to send reminder notifications after initial alert.
    RunBasedEscalations List<HeartbeatCheckAlertSettingsRunBasedEscalation>
    Configuration for run-based escalation.
    SslCertificates List<HeartbeatCheckAlertSettingsSslCertificate>

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    TimeBasedEscalations List<HeartbeatCheckAlertSettingsTimeBasedEscalation>
    Configuration for time-based escalation.
    EscalationType string
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    ParallelRunFailureThresholds []HeartbeatCheckAlertSettingsParallelRunFailureThreshold
    Configuration for parallel run failure threshold.
    Reminders []HeartbeatCheckAlertSettingsReminder
    Defines how often to send reminder notifications after initial alert.
    RunBasedEscalations []HeartbeatCheckAlertSettingsRunBasedEscalation
    Configuration for run-based escalation.
    SslCertificates []HeartbeatCheckAlertSettingsSslCertificate

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    TimeBasedEscalations []HeartbeatCheckAlertSettingsTimeBasedEscalation
    Configuration for time-based escalation.
    escalationType String
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallelRunFailureThresholds List<HeartbeatCheckAlertSettingsParallelRunFailureThreshold>
    Configuration for parallel run failure threshold.
    reminders List<HeartbeatCheckAlertSettingsReminder>
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations List<HeartbeatCheckAlertSettingsRunBasedEscalation>
    Configuration for run-based escalation.
    sslCertificates List<HeartbeatCheckAlertSettingsSslCertificate>

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    timeBasedEscalations List<HeartbeatCheckAlertSettingsTimeBasedEscalation>
    Configuration for time-based escalation.
    escalationType string
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallelRunFailureThresholds HeartbeatCheckAlertSettingsParallelRunFailureThreshold[]
    Configuration for parallel run failure threshold.
    reminders HeartbeatCheckAlertSettingsReminder[]
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations HeartbeatCheckAlertSettingsRunBasedEscalation[]
    Configuration for run-based escalation.
    sslCertificates HeartbeatCheckAlertSettingsSslCertificate[]

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    timeBasedEscalations HeartbeatCheckAlertSettingsTimeBasedEscalation[]
    Configuration for time-based escalation.
    escalation_type str
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallel_run_failure_thresholds Sequence[HeartbeatCheckAlertSettingsParallelRunFailureThreshold]
    Configuration for parallel run failure threshold.
    reminders Sequence[HeartbeatCheckAlertSettingsReminder]
    Defines how often to send reminder notifications after initial alert.
    run_based_escalations Sequence[HeartbeatCheckAlertSettingsRunBasedEscalation]
    Configuration for run-based escalation.
    ssl_certificates Sequence[HeartbeatCheckAlertSettingsSslCertificate]

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    time_based_escalations Sequence[HeartbeatCheckAlertSettingsTimeBasedEscalation]
    Configuration for time-based escalation.
    escalationType String
    Determines the type of escalation to use. Possible values are RUN_BASED and TIME_BASED. (Default RUN_BASED).
    parallelRunFailureThresholds List<Property Map>
    Configuration for parallel run failure threshold.
    reminders List<Property Map>
    Defines how often to send reminder notifications after initial alert.
    runBasedEscalations List<Property Map>
    Configuration for run-based escalation.
    sslCertificates List<Property Map>

    Deprecated: This legacy attribute is no longer available and even if set, does not affect behavior. It will be removed in the next major version.

    timeBasedEscalations List<Property Map>
    Configuration for time-based escalation.

    HeartbeatCheckAlertSettingsParallelRunFailureThreshold, HeartbeatCheckAlertSettingsParallelRunFailureThresholdArgs

    Enabled bool
    Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default false).
    Percentage int
    Percentage of runs that must fail to trigger alert. Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. (Default 10).
    Enabled bool
    Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default false).
    Percentage int
    Percentage of runs that must fail to trigger alert. Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. (Default 10).
    enabled Boolean
    Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default false).
    percentage Integer
    Percentage of runs that must fail to trigger alert. Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. (Default 10).
    enabled boolean
    Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default false).
    percentage number
    Percentage of runs that must fail to trigger alert. Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. (Default 10).
    enabled bool
    Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default false).
    percentage int
    Percentage of runs that must fail to trigger alert. Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. (Default 10).
    enabled Boolean
    Whether parallel run failure threshold is enabled. Only applies if the monitor is scheduled for multiple locations in parallel. (Default false).
    percentage Number
    Percentage of runs that must fail to trigger alert. Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100. (Default 10).

    HeartbeatCheckAlertSettingsReminder, HeartbeatCheckAlertSettingsReminderArgs

    Amount int
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    Interval int
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    Amount int
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    Interval int
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount Integer
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval Integer
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount number
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval number
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount int
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval int
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).
    amount Number
    Number of reminder notifications to send. Possible values are 0, 1, 2, 3, 4, 5, and 100000 (0 to disable, 100000 for unlimited). (Default 0).
    interval Number
    Interval between reminder notifications in minutes. Possible values are 5, 10, 15, and 30. (Default 5).

    HeartbeatCheckAlertSettingsRunBasedEscalation, HeartbeatCheckAlertSettingsRunBasedEscalationArgs

    FailedRunThreshold int
    Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between 1 and 5. (Default 1).
    FailedRunThreshold int
    Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold Integer
    Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold number
    Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between 1 and 5. (Default 1).
    failed_run_threshold int
    Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold Number
    Send an alert notification after the given number of consecutive monitor runs have failed. Possible values are between 1 and 5. (Default 1).

    HeartbeatCheckAlertSettingsSslCertificate, HeartbeatCheckAlertSettingsSslCertificateArgs

    AlertThreshold int
    No longer available.
    Enabled bool
    No longer available.
    AlertThreshold int
    No longer available.
    Enabled bool
    No longer available.
    alertThreshold Integer
    No longer available.
    enabled Boolean
    No longer available.
    alertThreshold number
    No longer available.
    enabled boolean
    No longer available.
    alert_threshold int
    No longer available.
    enabled bool
    No longer available.
    alertThreshold Number
    No longer available.
    enabled Boolean
    No longer available.

    HeartbeatCheckAlertSettingsTimeBasedEscalation, HeartbeatCheckAlertSettingsTimeBasedEscalationArgs

    MinutesFailingThreshold int
    Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    MinutesFailingThreshold int
    Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold Integer
    Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold number
    Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutes_failing_threshold int
    Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold Number
    Send an alert notification after the monitor has been failing for the given amount of time (in minutes). Possible values are 5, 10, 15, and 30. (Default 5).

    HeartbeatCheckHeartbeat, HeartbeatCheckHeartbeatArgs

    Grace int
    How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
    GraceUnit string
    Possible values seconds, minutes, hours and days.
    Period int
    How often you expect a ping to the ping URL.
    PeriodUnit string
    Possible values seconds, minutes, hours and days.
    PingToken string
    Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
    Grace int
    How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
    GraceUnit string
    Possible values seconds, minutes, hours and days.
    Period int
    How often you expect a ping to the ping URL.
    PeriodUnit string
    Possible values seconds, minutes, hours and days.
    PingToken string
    Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
    grace Integer
    How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
    graceUnit String
    Possible values seconds, minutes, hours and days.
    period Integer
    How often you expect a ping to the ping URL.
    periodUnit String
    Possible values seconds, minutes, hours and days.
    pingToken String
    Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
    grace number
    How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
    graceUnit string
    Possible values seconds, minutes, hours and days.
    period number
    How often you expect a ping to the ping URL.
    periodUnit string
    Possible values seconds, minutes, hours and days.
    pingToken string
    Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
    grace int
    How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
    grace_unit str
    Possible values seconds, minutes, hours and days.
    period int
    How often you expect a ping to the ping URL.
    period_unit str
    Possible values seconds, minutes, hours and days.
    ping_token str
    Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].
    grace Number
    How long Checkly should wait before triggering any alerts when a ping does not arrive within the set period.
    graceUnit String
    Possible values seconds, minutes, hours and days.
    period Number
    How often you expect a ping to the ping URL.
    periodUnit String
    Possible values seconds, minutes, hours and days.
    pingToken String
    Custom token to generate your ping URL. Checkly will expect a ping to https://ping.checklyhq.com/[PING_TOKEN].

    HeartbeatCheckTriggerIncident, HeartbeatCheckTriggerIncidentArgs

    Description string
    A detailed description of the incident.
    Name string
    The name of the incident.
    NotifySubscribers bool
    Whether to notify subscribers when the incident is triggered.
    ServiceId string
    The status page service that this incident will be associated with.
    Severity string
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    Description string
    A detailed description of the incident.
    Name string
    The name of the incident.
    NotifySubscribers bool
    Whether to notify subscribers when the incident is triggered.
    ServiceId string
    The status page service that this incident will be associated with.
    Severity string
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description String
    A detailed description of the incident.
    name String
    The name of the incident.
    notifySubscribers Boolean
    Whether to notify subscribers when the incident is triggered.
    serviceId String
    The status page service that this incident will be associated with.
    severity String
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description string
    A detailed description of the incident.
    name string
    The name of the incident.
    notifySubscribers boolean
    Whether to notify subscribers when the incident is triggered.
    serviceId string
    The status page service that this incident will be associated with.
    severity string
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description str
    A detailed description of the incident.
    name str
    The name of the incident.
    notify_subscribers bool
    Whether to notify subscribers when the incident is triggered.
    service_id str
    The status page service that this incident will be associated with.
    severity str
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.
    description String
    A detailed description of the incident.
    name String
    The name of the incident.
    notifySubscribers Boolean
    Whether to notify subscribers when the incident is triggered.
    serviceId String
    The status page service that this incident will be associated with.
    severity String
    The severity level of the incident. Possible values are MINOR, MEDIUM, MAJOR, and CRITICAL.

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the checkly Terraform Provider.
    checkly logo
    Checkly v2.7.0 published on Tuesday, Nov 4, 2025 by Checkly
    checkly/pulumi-checkly
      Meet Neo: Your AI Platform Teammate