Skip to main content
POST
/
v1
/
heartbeats
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>",
      "description": "<string>",
      "alert_summary": "<string>",
      "alert_description": "<string>",
      "alert_urgency_id": "<string>",
      "interval": 123,
      "interval_unit": "seconds",
      "notification_target_id": "<string>",
      "notification_target_type": "User",
      "enabled": true
    }
  }
}'
{
  "data": {
    "id": "b6d71b34-b0d2-4775-b694-17f287b09eeb",
    "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": "9892c58c-2187-4c1a-86c6-9345731d95f5",
      "interval": 1,
      "interval_unit": "minutes",
      "notification_target_id": "208",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/b6d71b34-b0d2-4775-b694-17f287b09eeb/ping",
      "secret": "heartbeat_e8f3610dd928a99387d79f3470e593e22aed4c7f8f0d2e817d4926505a719d96",
      "email_address": "heartbeat-8e68cd18db28cd65d33cf4a586197368@test.email.rootly.com",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-10-29T12:09:31.807-07:00",
      "created_at": "2025-10-29T12:09:31.807-07:00"
    }
  }
}

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

Response

heartbeat created

data
object
required