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>",
      "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": "4a2266cc-9f94-46ac-903a-8d0e46d24328",
    "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": "d7462569-7440-4689-a7ce-79d6fd77186d",
      "interval": 1,
      "interval_unit": "minutes",
      "notification_target_id": "416",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/4a2266cc-9f94-46ac-903a-8d0e46d24328/ping",
      "secret": "heartbeat_11afde3f0079f4b67652f189be99477b94f805484fcc04df6a63b9f682bdbc5f",
      "email_address": "[email protected]",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2026-01-23T22:57:09.198-08:00",
      "created_at": "2026-01-23T22:57:09.198-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