Heartbeats

Add a heartbeat

post/heartbeats

Request

  • Base URL: https://api.pulsetic.com/api/public
  • URL: https://api.pulsetic.com/api/public/heartbeats
  • Auth: API key in header Authorization

Request body

namestring required
monitoring_intervalinteger required
grace_periodinteger required
alert_emailboolean
alert_smsboolean
alert_voiceboolean
tagsstring[]

Tag names to attach to the created heartbeat. Existing tags with the same name (anywhere on your team) are reused instead of duplicated; unknown names are created automatically.

Example request

{
  "monitoring_interval": 60,
  "grace_period": 180,
  "alert_email": true,
  "tags": [
    "production",
    "critical"
  ]
}

Response

successful operation

idinteger
namestring
monitoring_intervalinteger

Expected heartbeat interval in seconds.

grace_periodinteger

Grace period in seconds before alerting.

alert_emailboolean
alert_smsboolean
alert_voiceboolean
created_atstring date-time
updated_atstring date-time

Example response

{
  "monitoring_interval": 60,
  "grace_period": 180,
  "tags": [
    {
      "name": "production"
    },
    {
      "name": "critical"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.