Skip to content

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.

Options

OptionEndpointWhat it sets up
Start uptime monitoringPOST https://api.navi.sh/v1/quickstart/startMonitoringChecks a URL on a schedule and alerts when it goes down
Start alert ingestionPOST https://api.navi.sh/v1/quickstart/startIngestingReturns a ready-to-use webhook URL for your monitoring tool

Error responses

Both endpoints share the same error contract:

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

Built by the Navi.sh team.