Get ping instructions
get_ping_instructionsReturns ping URLs, copy-paste snippets, and reporting options to wire a new monitor, including manual, hook, and run-wrapper setup instructions.
Instructions
Requires the read scope or higher. Returns what a monitor needs in order to report: its ping URLs, copy-paste snippets (curl_success, curl_start, curl_fail, curl_step, run_example) and three reporting mechanisms, for wiring up a new monitor. reporting_options holds the rule for choosing between them: how_to is the manual protocol and works in any agent with no prerequisite (with expect_every_s, a lapse opens an incident); hook_install is a one-time install that automates the same protocol through hooks and alone sends every state, blocked and note included; it is returned only when tool is set (claude-code, codex or antigravity), otherwise hook_install_note says so; run_wrapper puts lastping run before a launched command (cron job, CI step, script) and reports start, success, fail and cancel. Also returned: failure_inbox_how_to, expectations_how_to (declare_run_expectations), tracing_how_to (OpenTelemetry, detailed by get_trace_setup), otel_env_lines, export lines whose key placeholder stands for the person's tracing key, and docs_url. An exporter that cannot set headers can POST to <ping_url>/v1/traces, which needs no Authorization header.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Monitor UUID (from create_monitor or list_monitors). | |
| tool | No | Which tool's install `hook_install` carries: claude-code, codex or antigravity. `hook_install` is returned only when this is set. Everything else in the result is the same. |