HOhoneybadger
Check-ins

Create a check-in

Creates a new check-in monitor.

post/projects/{project_id}/check_ins

Request

Path parameters

project_idstring required
Example:Xk9mZp

Project ID

Request body

namestring nullable

Display name. Null clears it; an unnamed check-in shows its ID.

slugstring nullable

Short identifier used in the check-in's reporting URL. Null clears it. Renaming it breaks jobs reporting to …/check_in/<ingestion key>/<slug> and changes how PUT /check_ins matches this check-in.

schedule_type'simple' | 'cron'

simple expects a report every report_period. cron expects reports on a cron schedule and requires cron_schedule.

report_periodstring nullable

How often a report is expected, for simple schedules. Required unless schedule_type is cron, and may not be zero. A duration such as 5 minutes, 1 hour 30 minutes or 01:30:00. Returned in long form: 1 week comes back as 7 days.

grace_periodstring nullable

How long after the expected time before the check-in is considered missing. Same format as report_period; zero is 00:00:00. Null resets it to zero.

cron_schedulestring nullable

Cron expression, required when schedule_type is cron.

cron_timezonestring nullable

Timezone the cron schedule is evaluated in. A time zone name as the web app lists them, not an IANA identifier — Central Time (US & Canada), not America/Chicago, which is rejected. Required when schedule_type is cron. Null resets it to UTC.

Example request

{
  "name": "Nightly billing job",
  "slug": "nightly-billing",
  "report_period": "1 day",
  "grace_period": "10 minutes",
  "cron_schedule": "0 3 * * *",
  "cron_timezone": "Central Time (US & Canada)"
}

Response

Check-in created

Example response

{
  "data": {
    "id": "Ci5xWq",
    "project_id": "Xk9mZp",
    "name": "Daily Backup",
    "slug": "daily-backup",
    "grace_period": "10 minutes",
    "report_url": "https://api.honeybadger.io/v1/check_in/Ci5xWq",
    "cron_schedule": "0 2 * * *",
    "cron_timezone": "Eastern Time (US & Canada)",
    "report_period": "1 day",
    "links": {
      "web": "https://app.honeybadger.io/projects/Xk9mZp"
    }
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

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