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": "9b7ea167-9a6b-484b-ba37-e597d99108d6",
    "type": "heartbeats",
    "attributes": {
      "slug": "api",
      "name": "API",
      "description": "This is a description",
      "alert_summary": "API is down",
      "alert_urgency_id": "b5ce9b3f-e49e-4f03-b15a-1d086d0f5e3f",
      "interval": 1,
      "interval_unit": "minutes",
      "notification_target_id": "158",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/9b7ea167-9a6b-484b-ba37-e597d99108d6/ping",
      "secret": "heartbeat_37ad03ebb3bfe2c1007c99427470b40c1d5e5b711043645f821e5e97ec15bd62",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-07-08T03:27:13.991-07:00",
      "created_at": "2025-07-08T03:27:13.991-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.