1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. Heartbeat
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.Heartbeat

rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Example Usage

    resource "rootly_heartbeat" "nightly_backup" {
  name                     = "nightly-db-backup"
  description              = "Nightly database backup cron job"
  interval                 = 24
  interval_unit            = "hours"
  alert_summary            = "Nightly backup missed"
  notification_target_type = "Service"
  notification_target_id   = rootly_service.elasticsearch_prod.id
  enabled                  = true
}

    Create Heartbeat Resource

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

    Constructor syntax

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

@overload
def Heartbeat(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              interval: Optional[int] = None,
              alert_summary: Optional[str] = None,
              notification_target_id: Optional[str] = None,
              interval_unit: Optional[str] = None,
              email_address: Optional[str] = None,
              enabled: Optional[bool] = None,
              expires_at: Optional[str] = None,
              description: Optional[str] = None,
              alert_description: Optional[str] = None,
              last_pinged_at: Optional[str] = None,
              name: Optional[str] = None,
              alert_urgency_id: Optional[str] = None,
              notification_target_type: Optional[str] = None,
              ping_url: Optional[str] = None,
              secret: Optional[str] = None,
              status: Optional[str] = None)
    func NewHeartbeat(ctx *Context, name string, args HeartbeatArgs, opts ...ResourceOption) (*Heartbeat, error)
    public Heartbeat(string name, HeartbeatArgs args, CustomResourceOptions? opts = null)
    public Heartbeat(String name, HeartbeatArgs args)
public Heartbeat(String name, HeartbeatArgs args, CustomResourceOptions options)

    type: rootly:Heartbeat
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 HeartbeatArgs
    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 HeartbeatArgs
    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 HeartbeatArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HeartbeatArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HeartbeatArgs
    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 heartbeatResource = new Rootly.Heartbeat("heartbeatResource", new()
{
    Interval = 0,
    AlertSummary = "string",
    NotificationTargetId = "string",
    IntervalUnit = "string",
    EmailAddress = "string",
    Enabled = false,
    ExpiresAt = "string",
    Description = "string",
    AlertDescription = "string",
    LastPingedAt = "string",
    Name = "string",
    AlertUrgencyId = "string",
    NotificationTargetType = "string",
    PingUrl = "string",
    Secret = "string",
    Status = "string",
});

    example, err := rootly.NewHeartbeat(ctx, "heartbeatResource", &rootly.HeartbeatArgs{
	Interval:               pulumi.Int(0),
	AlertSummary:           pulumi.String("string"),
	NotificationTargetId:   pulumi.String("string"),
	IntervalUnit:           pulumi.String("string"),
	EmailAddress:           pulumi.String("string"),
	Enabled:                pulumi.Bool(false),
	ExpiresAt:              pulumi.String("string"),
	Description:            pulumi.String("string"),
	AlertDescription:       pulumi.String("string"),
	LastPingedAt:           pulumi.String("string"),
	Name:                   pulumi.String("string"),
	AlertUrgencyId:         pulumi.String("string"),
	NotificationTargetType: pulumi.String("string"),
	PingUrl:                pulumi.String("string"),
	Secret:                 pulumi.String("string"),
	Status:                 pulumi.String("string"),
})

    var heartbeatResource = new Heartbeat("heartbeatResource", HeartbeatArgs.builder()
    .interval(0)
    .alertSummary("string")
    .notificationTargetId("string")
    .intervalUnit("string")
    .emailAddress("string")
    .enabled(false)
    .expiresAt("string")
    .description("string")
    .alertDescription("string")
    .lastPingedAt("string")
    .name("string")
    .alertUrgencyId("string")
    .notificationTargetType("string")
    .pingUrl("string")
    .secret("string")
    .status("string")
    .build());

    heartbeat_resource = rootly.Heartbeat("heartbeatResource",
    interval=0,
    alert_summary="string",
    notification_target_id="string",
    interval_unit="string",
    email_address="string",
    enabled=False,
    expires_at="string",
    description="string",
    alert_description="string",
    last_pinged_at="string",
    name="string",
    alert_urgency_id="string",
    notification_target_type="string",
    ping_url="string",
    secret="string",
    status="string")

    const heartbeatResource = new rootly.Heartbeat("heartbeatResource", {
    interval: 0,
    alertSummary: "string",
    notificationTargetId: "string",
    intervalUnit: "string",
    emailAddress: "string",
    enabled: false,
    expiresAt: "string",
    description: "string",
    alertDescription: "string",
    lastPingedAt: "string",
    name: "string",
    alertUrgencyId: "string",
    notificationTargetType: "string",
    pingUrl: "string",
    secret: "string",
    status: "string",
});

    type: rootly:Heartbeat
properties:
    alertDescription: string
    alertSummary: string
    alertUrgencyId: string
    description: string
    emailAddress: string
    enabled: false
    expiresAt: string
    interval: 0
    intervalUnit: string
    lastPingedAt: string
    name: string
    notificationTargetId: string
    notificationTargetType: string
    pingUrl: string
    secret: string
    status: string

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

    AlertSummary string
    Summary of alerts triggered when heartbeat expires.
    Interval int
    NotificationTargetId string
    AlertDescription string
    Description of alerts triggered when heartbeat expires.
    AlertUrgencyId string
    Urgency of alerts triggered when heartbeat expires.
    Description string
    The description of the heartbeat
    EmailAddress string
    Email address to receive heartbeat pings.
    Enabled bool
    ExpiresAt string
    When heartbeat expires
    IntervalUnit string
    Value must be one of minutes, hours, days.
    LastPingedAt string
    When the heartbeat was last pinged.
    Name string
    The name of the heartbeat
    NotificationTargetType string
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    PingUrl string
    URL to receive heartbeat pings.
    Secret string
    Secret used as bearer token when pinging heartbeat.
    Status string
    Value must be one of waiting, active, expired.
    AlertSummary string
    Summary of alerts triggered when heartbeat expires.
    Interval int
    NotificationTargetId string
    AlertDescription string
    Description of alerts triggered when heartbeat expires.
    AlertUrgencyId string
    Urgency of alerts triggered when heartbeat expires.
    Description string
    The description of the heartbeat
    EmailAddress string
    Email address to receive heartbeat pings.
    Enabled bool
    ExpiresAt string
    When heartbeat expires
    IntervalUnit string
    Value must be one of minutes, hours, days.
    LastPingedAt string
    When the heartbeat was last pinged.
    Name string
    The name of the heartbeat
    NotificationTargetType string
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    PingUrl string
    URL to receive heartbeat pings.
    Secret string
    Secret used as bearer token when pinging heartbeat.
    Status string
    Value must be one of waiting, active, expired.
    alertSummary String
    Summary of alerts triggered when heartbeat expires.
    interval Integer
    notificationTargetId String
    alertDescription String
    Description of alerts triggered when heartbeat expires.
    alertUrgencyId String
    Urgency of alerts triggered when heartbeat expires.
    description String
    The description of the heartbeat
    emailAddress String
    Email address to receive heartbeat pings.
    enabled Boolean
    expiresAt String
    When heartbeat expires
    intervalUnit String
    Value must be one of minutes, hours, days.
    lastPingedAt String
    When the heartbeat was last pinged.
    name String
    The name of the heartbeat
    notificationTargetType String
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    pingUrl String
    URL to receive heartbeat pings.
    secret String
    Secret used as bearer token when pinging heartbeat.
    status String
    Value must be one of waiting, active, expired.
    alertSummary string
    Summary of alerts triggered when heartbeat expires.
    interval number
    notificationTargetId string
    alertDescription string
    Description of alerts triggered when heartbeat expires.
    alertUrgencyId string
    Urgency of alerts triggered when heartbeat expires.
    description string
    The description of the heartbeat
    emailAddress string
    Email address to receive heartbeat pings.
    enabled boolean
    expiresAt string
    When heartbeat expires
    intervalUnit string
    Value must be one of minutes, hours, days.
    lastPingedAt string
    When the heartbeat was last pinged.
    name string
    The name of the heartbeat
    notificationTargetType string
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    pingUrl string
    URL to receive heartbeat pings.
    secret string
    Secret used as bearer token when pinging heartbeat.
    status string
    Value must be one of waiting, active, expired.
    alert_summary str
    Summary of alerts triggered when heartbeat expires.
    interval int
    notification_target_id str
    alert_description str
    Description of alerts triggered when heartbeat expires.
    alert_urgency_id str
    Urgency of alerts triggered when heartbeat expires.
    description str
    The description of the heartbeat
    email_address str
    Email address to receive heartbeat pings.
    enabled bool
    expires_at str
    When heartbeat expires
    interval_unit str
    Value must be one of minutes, hours, days.
    last_pinged_at str
    When the heartbeat was last pinged.
    name str
    The name of the heartbeat
    notification_target_type str
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    ping_url str
    URL to receive heartbeat pings.
    secret str
    Secret used as bearer token when pinging heartbeat.
    status str
    Value must be one of waiting, active, expired.
    alertSummary String
    Summary of alerts triggered when heartbeat expires.
    interval Number
    notificationTargetId String
    alertDescription String
    Description of alerts triggered when heartbeat expires.
    alertUrgencyId String
    Urgency of alerts triggered when heartbeat expires.
    description String
    The description of the heartbeat
    emailAddress String
    Email address to receive heartbeat pings.
    enabled Boolean
    expiresAt String
    When heartbeat expires
    intervalUnit String
    Value must be one of minutes, hours, days.
    lastPingedAt String
    When the heartbeat was last pinged.
    name String
    The name of the heartbeat
    notificationTargetType String
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    pingUrl String
    URL to receive heartbeat pings.
    secret String
    Secret used as bearer token when pinging heartbeat.
    status String
    Value must be one of waiting, active, expired.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Heartbeat 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 Heartbeat Resource

    Get an existing Heartbeat 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?: HeartbeatState, opts?: CustomResourceOptions): Heartbeat
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alert_description: Optional[str] = None,
        alert_summary: Optional[str] = None,
        alert_urgency_id: Optional[str] = None,
        description: Optional[str] = None,
        email_address: Optional[str] = None,
        enabled: Optional[bool] = None,
        expires_at: Optional[str] = None,
        interval: Optional[int] = None,
        interval_unit: Optional[str] = None,
        last_pinged_at: Optional[str] = None,
        name: Optional[str] = None,
        notification_target_id: Optional[str] = None,
        notification_target_type: Optional[str] = None,
        ping_url: Optional[str] = None,
        secret: Optional[str] = None,
        status: Optional[str] = None) -> Heartbeat
    func GetHeartbeat(ctx *Context, name string, id IDInput, state *HeartbeatState, opts ...ResourceOption) (*Heartbeat, error)
    public static Heartbeat Get(string name, Input<string> id, HeartbeatState? state, CustomResourceOptions? opts = null)
    public static Heartbeat get(String name, Output<String> id, HeartbeatState state, CustomResourceOptions options)
    resources:  _:    type: rootly:Heartbeat    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:
    AlertDescription string
    Description of alerts triggered when heartbeat expires.
    AlertSummary string
    Summary of alerts triggered when heartbeat expires.
    AlertUrgencyId string
    Urgency of alerts triggered when heartbeat expires.
    Description string
    The description of the heartbeat
    EmailAddress string
    Email address to receive heartbeat pings.
    Enabled bool
    ExpiresAt string
    When heartbeat expires
    Interval int
    IntervalUnit string
    Value must be one of minutes, hours, days.
    LastPingedAt string
    When the heartbeat was last pinged.
    Name string
    The name of the heartbeat
    NotificationTargetId string
    NotificationTargetType string
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    PingUrl string
    URL to receive heartbeat pings.
    Secret string
    Secret used as bearer token when pinging heartbeat.
    Status string
    Value must be one of waiting, active, expired.
    AlertDescription string
    Description of alerts triggered when heartbeat expires.
    AlertSummary string
    Summary of alerts triggered when heartbeat expires.
    AlertUrgencyId string
    Urgency of alerts triggered when heartbeat expires.
    Description string
    The description of the heartbeat
    EmailAddress string
    Email address to receive heartbeat pings.
    Enabled bool
    ExpiresAt string
    When heartbeat expires
    Interval int
    IntervalUnit string
    Value must be one of minutes, hours, days.
    LastPingedAt string
    When the heartbeat was last pinged.
    Name string
    The name of the heartbeat
    NotificationTargetId string
    NotificationTargetType string
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    PingUrl string
    URL to receive heartbeat pings.
    Secret string
    Secret used as bearer token when pinging heartbeat.
    Status string
    Value must be one of waiting, active, expired.
    alertDescription String
    Description of alerts triggered when heartbeat expires.
    alertSummary String
    Summary of alerts triggered when heartbeat expires.
    alertUrgencyId String
    Urgency of alerts triggered when heartbeat expires.
    description String
    The description of the heartbeat
    emailAddress String
    Email address to receive heartbeat pings.
    enabled Boolean
    expiresAt String
    When heartbeat expires
    interval Integer
    intervalUnit String
    Value must be one of minutes, hours, days.
    lastPingedAt String
    When the heartbeat was last pinged.
    name String
    The name of the heartbeat
    notificationTargetId String
    notificationTargetType String
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    pingUrl String
    URL to receive heartbeat pings.
    secret String
    Secret used as bearer token when pinging heartbeat.
    status String
    Value must be one of waiting, active, expired.
    alertDescription string
    Description of alerts triggered when heartbeat expires.
    alertSummary string
    Summary of alerts triggered when heartbeat expires.
    alertUrgencyId string
    Urgency of alerts triggered when heartbeat expires.
    description string
    The description of the heartbeat
    emailAddress string
    Email address to receive heartbeat pings.
    enabled boolean
    expiresAt string
    When heartbeat expires
    interval number
    intervalUnit string
    Value must be one of minutes, hours, days.
    lastPingedAt string
    When the heartbeat was last pinged.
    name string
    The name of the heartbeat
    notificationTargetId string
    notificationTargetType string
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    pingUrl string
    URL to receive heartbeat pings.
    secret string
    Secret used as bearer token when pinging heartbeat.
    status string
    Value must be one of waiting, active, expired.
    alert_description str
    Description of alerts triggered when heartbeat expires.
    alert_summary str
    Summary of alerts triggered when heartbeat expires.
    alert_urgency_id str
    Urgency of alerts triggered when heartbeat expires.
    description str
    The description of the heartbeat
    email_address str
    Email address to receive heartbeat pings.
    enabled bool
    expires_at str
    When heartbeat expires
    interval int
    interval_unit str
    Value must be one of minutes, hours, days.
    last_pinged_at str
    When the heartbeat was last pinged.
    name str
    The name of the heartbeat
    notification_target_id str
    notification_target_type str
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    ping_url str
    URL to receive heartbeat pings.
    secret str
    Secret used as bearer token when pinging heartbeat.
    status str
    Value must be one of waiting, active, expired.
    alertDescription String
    Description of alerts triggered when heartbeat expires.
    alertSummary String
    Summary of alerts triggered when heartbeat expires.
    alertUrgencyId String
    Urgency of alerts triggered when heartbeat expires.
    description String
    The description of the heartbeat
    emailAddress String
    Email address to receive heartbeat pings.
    enabled Boolean
    expiresAt String
    When heartbeat expires
    interval Number
    intervalUnit String
    Value must be one of minutes, hours, days.
    lastPingedAt String
    When the heartbeat was last pinged.
    name String
    The name of the heartbeat
    notificationTargetId String
    notificationTargetType String
    The type of the notification target. Please contact support if you encounter issues using Functionality as a target type.. Value must be one of User, Group, Service, EscalationPolicy, Functionality.
    pingUrl String
    URL to receive heartbeat pings.
    secret String
    Secret used as bearer token when pinging heartbeat.
    status String
    Value must be one of waiting, active, expired.

    Import

    rootly.Heartbeat can be imported using the import command.

    $ pulumi import rootly:index/heartbeat:Heartbeat primary a816421c-6ceb-481a-87c4-585e47451f24

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly
      Try Pulumi Cloud free. Your team will thank you.