POST
/
v1
/
heartbeats
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": "3fe08470-a658-43bf-b5b6-ceb3338f7779",
    "type": "heartbeats",
    "attributes": {
      "slug": "api",
      "name": "API",
      "description": "This is a description",
      "alert_summary": "API is down",
      "alert_urgency_id": "470ce014-bff6-4e0f-84e2-49297e37ff42",
      "interval": 1,
      "interval_unit": "minutes",
      "notification_target_id": "158",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/3fe08470-a658-43bf-b5b6-ceb3338f7779/ping",
      "secret": "heartbeat_2504b1c772a0cd71c043365850f2d23a9133e19458deee42b56bb9aca2b86f8c",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-07-06T14:09:14.332-07:00",
      "created_at": "2025-07-06T14:09:14.332-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

Response

201
application/vnd.api+json

heartbeat created

The response is of type object.