Skip to content

Try the API

Test the OutboundSync API against production without leaving the docs — no curl, no Postman, no separate console. The health check below is already selected and needs no key, so hit Send request to see it work.

Live API consoleSend real requests to production
Interactive
curl 'https://app.outboundsync.com/health/ready' \
  -X GET

Health checks vs. account endpoints

Section titled “Health checks vs. account endpoints”

The dropdown has two groups:

  • Platform health (no key) — GET /health/live and GET /health/ready answer “is OutboundSync up?” Anyone can run them, which is what you just did.
  • Your account (key required) — identity, pipeline readiness, connections, and sources answer “is my integration working?” These read your account, so they need an API key. Create one in Creating API keys.

Both groups come from the live OpenAPI document, so the menu always matches what the API serves. For request and response details, see the API v1 reference and Platform health endpoints.

How your API key is handled

Section titled “How your API key is handled”

Paste a key and here is exactly what happens to it:

  • It stays in this browser tab. The key lives in the tab’s sessionStorage. Close the tab and it is gone; clear the field and it is removed at once. It is never written to a cookie, saved to a database, or sent to our servers.
  • It goes straight to the API. Requests run from your browser to https://app.outboundsync.com over HTTPS with the key in the Authorization header — the same call your own code makes. Nothing is proxied through this docs site.
  • It can only read. Every v1 endpoint is a GET and returns no secrets, so a test request cannot change your account or your data.

Use a connection-scoped key for exploration, avoid shared machines, and revoke the key if it is ever exposed.

Section titled “Related”