Quickstart

Two API endpoints let you create a trial Navi.sh workspace straight from the landing page — no account required. Both are protected by a Cloudflare Turnstile CAPTCHA token that the navi.sh web widget supplies automatically.

Once the request succeeds, you receive an activation link by email that takes you directly into a pre-configured dashboard.

---

Start uptime monitoring

Set up a trial workspace that continuously checks whether a URL is reachable.

Endpoint: POST /api/v1/quickstart/startMonitoring

Request

Field	Type	Required	Description
email	string	✓	Your email. An activation link will be sent here.
turnstile_token	string	✓	Cloudflare Turnstile token from the widget.
url	string	✓	Full URL to monitor (e.g. https://example.com).
interval	string	✓	Check frequency: 1m, 5m, 15m, or 1h.
expected_status	integer		Expected HTTP status code. Defaults to 200.

Example

curl -X POST https://api.navi.sh/api/v1/quickstart/startMonitoring \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "turnstile_token": "0.abc123...",
    "url": "https://example.com",
    "interval": "5m",
    "expected_status": 200
  }'

Response 200 OK

{
  "status": "ok",
  "message": "Monitoring started. Check your email to access your dashboard."
}

---

Start alert ingestion

Set up a trial workspace with a pre-configured integration for your monitoring tool. The response contains a ready-to-use ingestion webhook URL you can paste directly into your tool.

Endpoint: POST /api/v1/quickstart/startIngesting

Request

Field	Type	Required	Description
email	string	✓	Your email. An activation link will be sent here.
turnstile_token	string	✓	Cloudflare Turnstile token from the widget.
serviceName	string	✓	Name for the service that will receive alerts.
source	string	✓	Monitoring tool: webhook, cloudwatch, datadog, prometheus, grafana, or new_relic.

Example

curl -X POST https://api.navi.sh/api/v1/quickstart/startIngesting \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "turnstile_token": "0.abc123...",
    "serviceName": "production-api",
    "source": "datadog"
  }'

Response 200 OK

{
  "status": "ok",
  "url_for_ingestion": "https://api.navi.sh/api/v1/events/datadog/eyJhbGci...",
  "message": "Check your email to access your dashboard."
}

Copy the url_for_ingestion value and paste it as the webhook destination in your Datadog (or other tool) settings.

---

Error responses

Both endpoints share the same error contract:

Status	error value	Cause
409	An organization with this email domain already exists.	Domain is already registered.
422	Invalid interval. Allowed values: 1m, 5m, 15m, 1h.	Bad interval value.
422	Invalid source. Allowed values: webhook, new_relic, ...	Bad source value.
422	Disposable or alias email domains are not allowed.	Use a real email address.
403	Captcha verification failed. Please try again.	Invalid or expired Turnstile token.
429	Too many requests for this email. Please wait 30 minutes.	Rate limit hit.
500	Something went wrong. Please try again.	Unexpected server error.

---

Next steps

After clicking the activation link in your email:

1. Your workspace is ready — no further setup required.
2. If you used startIngesting, alerts are already flowing in as soon as you configure the webhook in your tool.
3. If you used startMonitoring, the first check fires within the chosen interval.

Explore the Integrations section for detailed setup guides for each monitoring tool.