Creates a new heartbeat from provided data
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>",
"description": "<string>",
"alert_summary": "<string>",
"alert_urgency_id": "<string>",
"interval": 123,
"interval_unit": "seconds",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}'
{
"data": {
"id": "f054cca2-8607-4246-b97c-afd20a38ecd3",
"type": "heartbeats",
"attributes": {
"slug": "api",
"name": "API",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "0e040654-e151-43fd-8003-9e8005ba7c18",
"interval": 1,
"interval_unit": "minutes",
"notification_target_id": "175",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/f054cca2-8607-4246-b97c-afd20a38ecd3/ping",
"secret": "heartbeat_bf5e25fd6f6456f8afd90ef7de8e50312da0a70b36a7d03cb97c1183fdf25599",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-08-28T04:35:00.948-07:00",
"created_at": "2025-08-28T04:35:00.948-07:00"
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
heartbeat created
The response is of type object
.
Was this page helpful?
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>",
"description": "<string>",
"alert_summary": "<string>",
"alert_urgency_id": "<string>",
"interval": 123,
"interval_unit": "seconds",
"notification_target_id": "<string>",
"notification_target_type": "User",
"enabled": true
}
}
}'
{
"data": {
"id": "f054cca2-8607-4246-b97c-afd20a38ecd3",
"type": "heartbeats",
"attributes": {
"slug": "api",
"name": "API",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "0e040654-e151-43fd-8003-9e8005ba7c18",
"interval": 1,
"interval_unit": "minutes",
"notification_target_id": "175",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/f054cca2-8607-4246-b97c-afd20a38ecd3/ping",
"secret": "heartbeat_bf5e25fd6f6456f8afd90ef7de8e50312da0a70b36a7d03cb97c1183fdf25599",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-08-28T04:35:00.948-07:00",
"created_at": "2025-08-28T04:35:00.948-07:00"
}
}
}