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": "f412437c-f778-48d1-b793-35180b8d08d9",
    "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": "1ef4fa7a-eb64-4da3-9554-c27896fafc39",
      "interval": 1,
      "interval_unit": "minutes",
      "notification_target_id": "210",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/f412437c-f778-48d1-b793-35180b8d08d9/ping",
      "secret": "heartbeat_85669616c4806f8d86a381539cef982a56c68cc7ec850f47967f66198d00391e",
      "email_address": "heartbeat-456a347c259636c73fede8ba1e081373@test.email.rootly.com",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-11-27T00:08:50.592-08:00",
      "created_at": "2025-11-27T00:08:50.592-08: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