Creates a heartbeat

curl --request POST \ --url https://api.rootly.com/v1/heartbeats \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/vnd.api+json' \ --data ' { "data": { "type": "heartbeats", "attributes": { "name": "<string>", "alert_summary": "<string>", "interval": 123, "interval_unit": "seconds", "notification_target_id": "<string>", "notification_target_type": "User", "description": "<string>", "alert_description": "<string>", "alert_urgency_id": "<string>", "enabled": true } } } '

{ "data": { "id": "<string>", "type": "heartbeats", "attributes": { "name": "<string>", "alert_summary": "<string>", "interval": 123, "interval_unit": "seconds", "notification_target_id": "<string>", "notification_target_type": "User", "enabled": true, "status": "waiting", "email_address": "<string>", "created_at": "<string>", "updated_at": "<string>", "description": "<string>", "alert_description": "<string>", "alert_urgency_id": "<string>", "ping_url": "<string>", "secret": "<string>", "last_pinged_at": "<string>", "expires_at": "<string>" } } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json

data

object

required

Show child attributes

data.type

enum<string>

required

Available options:

heartbeats

data.attributes

object

required

Show child attributes

data.attributes.name

string

required

The name of the heartbeat

data.attributes.alert_summary

string

required

Summary of alerts triggered when heartbeat expires.

data.attributes.interval

integer

required

data.attributes.interval_unit

enum<string>

required

Available options:

seconds,

minutes,

hours

data.attributes.notification_target_id

string

required

data.attributes.notification_target_type

enum<string>

required

Available options:

User,

Group,

Service,

EscalationPolicy

data.attributes.description

string | null

The description of the heartbeat

data.attributes.alert_description

string | null

Description of alerts triggered when heartbeat expires.

data.attributes.alert_urgency_id

string | null

Urgency of alerts triggered when heartbeat expires.

data.attributes.enabled

boolean

Whether to trigger alerts when heartbeat is expired.

Response

heartbeat created

data

object

required

Show child attributes

data.id

string

required

Unique ID of the heartbeat

data.type

enum<string>

required

Available options:

heartbeats

data.attributes

object

required

Show child attributes

data.attributes.name

string

required

The name of the heartbeat

data.attributes.alert_summary

string

required

Summary of alerts triggered when heartbeat expires.

data.attributes.interval

integer

required

data.attributes.interval_unit

enum<string>

required

Available options:

seconds,

minutes,

hours

data.attributes.notification_target_id

string

required

data.attributes.notification_target_type

enum<string>

required

Available options:

User,

Group,

Service,

EscalationPolicy

data.attributes.enabled

boolean

required

Whether to trigger alerts when heartbeat is expired.

data.attributes.status

enum<string>

required

Available options:

waiting,

active,

expired

data.attributes.email_address

string

required

Email address to receive heartbeat pings.

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.description

string | null

The description of the heartbeat

data.attributes.alert_description

string | null

Description of alerts triggered when heartbeat expires.

data.attributes.alert_urgency_id

string | null

Urgency of alerts triggered when heartbeat expires.

data.attributes.ping_url

string | null

URL to receive heartbeat pings.

data.attributes.secret

string | null

Secret used as bearer token when pinging heartbeat.

data.attributes.last_pinged_at

string | null

When the heartbeat was last pinged.

data.attributes.expires_at

string | null

When heartbeat expires

Overview

AlertEvents

AlertFields

AlertGroups

AlertRoutes

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

Communications Groups

Communications Stages

Communications Templates

Communications Types

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays