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": "b01e73d3-674f-44f3-ba0c-d4bcb2b80390",
    "type": "heartbeats",
    "attributes": {
      "slug": "api",
      "name": "API",
      "description": "This is a description",
      "alert_summary": "API is down",
      "alert_urgency_id": "fd88194b-49dc-47d7-ae3f-5dd1ff34bedd",
      "interval": 1,
      "interval_unit": "minutes",
      "notification_target_id": "149",
      "notification_target_type": "User",
      "ping_url": "http://localhost:3001/v1/heartbeats/b01e73d3-674f-44f3-ba0c-d4bcb2b80390/ping",
      "secret": "heartbeat_184a1c63f1112f97fa82689580760229cf7a99b02b524c2d6a202a48ea153fe2",
      "last_pinged_at": null,
      "expires_at": null,
      "enabled": false,
      "status": "waiting",
      "updated_at": "2025-05-08T00:19:55.500-07:00",
      "created_at": "2025-05-08T00:19:55.500-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.