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>",
"alert_summary": "<string>",
"interval": 123,
"interval_unit": "minutes",
"notification_target_id": "<string>",
"notification_target_type": "User",
"description": "<string>",
"alert_description": "<string>",
"alert_urgency_id": "<string>",
"enabled": true
}
}
}
'{
"data": {
"id": "650771b5-d441-4480-b4c6-8b94c26956d3",
"type": "heartbeats",
"attributes": {
"slug": "api",
"name": "API",
"description": "This is a description",
"alert_summary": "API is down",
"alert_description": "Check the API logs and runbook at /docs/api-troubleshooting",
"alert_urgency_id": "b56cdc61-7322-4b5d-a07e-95cc48291e04",
"interval": 1,
"interval_unit": "minutes",
"notification_target_id": "224",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/650771b5-d441-4480-b4c6-8b94c26956d3/ping",
"secret": "heartbeat_10fb566b3f48219fab3ff8f8c79616d54c7649a6bc326a7fe723c7b0476bbadb",
"email_address": "[email protected]",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2026-01-03T21:27:11.980-08:00",
"created_at": "2026-01-03T21:27:11.980-08:00"
}
}
}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>",
"alert_summary": "<string>",
"interval": 123,
"interval_unit": "minutes",
"notification_target_id": "<string>",
"notification_target_type": "User",
"description": "<string>",
"alert_description": "<string>",
"alert_urgency_id": "<string>",
"enabled": true
}
}
}
'{
"data": {
"id": "650771b5-d441-4480-b4c6-8b94c26956d3",
"type": "heartbeats",
"attributes": {
"slug": "api",
"name": "API",
"description": "This is a description",
"alert_summary": "API is down",
"alert_description": "Check the API logs and runbook at /docs/api-troubleshooting",
"alert_urgency_id": "b56cdc61-7322-4b5d-a07e-95cc48291e04",
"interval": 1,
"interval_unit": "minutes",
"notification_target_id": "224",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/650771b5-d441-4480-b4c6-8b94c26956d3/ping",
"secret": "heartbeat_10fb566b3f48219fab3ff8f8c79616d54c7649a6bc326a7fe723c7b0476bbadb",
"email_address": "[email protected]",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2026-01-03T21:27:11.980-08:00",
"created_at": "2026-01-03T21:27:11.980-08:00"
}
}
}