Docs Getting started with PingArk

Getting started with PingArk

A check is one job you want to watch. It holds a schedule, a grace period, and a unique ping URL. Your job calls that URL when it runs, and PingArk alerts you if the call does not arrive on time.

1. Create a check

In the dashboard, click New check. Give it a name and, if you like, a slug, which is the readable part of the ping URL. Pick a schedule: a simple period such as every 60 minutes, a cron expression in your timezone, or a systemd OnCalendar expression. Set a grace period that covers the job's normal run time plus a little headroom. Tags and a short description are optional, and both help you stay organized once you have more than a handful of checks.

2. Ping from the job

Add a curl to the check ping URL as the last line of your job, so it runs only after the work succeeds.

curl -fsS -m 10 --retry 3 https://ping.pingark.com/ping/your-check-id
Copy

The check arms on its first ping, and a brand-new check never alerts until then. Every check also has a readable URL of the form /ping/<project-ping-key>/<slug>, and the two are interchangeable. For copy and paste examples in Bash, Python, PHP, Node, Go and more, see the client library guides.

3. Choose your alert channels

Under Channels, add email, which you verify once before it can alert, plus Slack, Discord, Telegram, a webhook, or PagerDuty. A check notifies every channel in its project unless you attach specific ones. Your check description rides along in email and Slack alerts, so whoever gets paged has the context.