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 matches what OpenAPI currently lists (introspection + health today). Webhook and event paths appear in the console when OpenAPI lists them — they are not in the live document yet. For webhook setup guidance, see OutboundSync webhooks. For the full contract, see the API v1 reference. For health details, see Platform health endpoints.

Path parameters, bodies, and writes

Section titled “Path parameters, bodies, and writes”

When OpenAPI includes an endpoint with path parameters (for example /api/v1/webhooks/{id}), the console shows inputs and substitutes them into the URL before Send. Operations with a JSON request body get a body editor seeded from the OpenAPI example — edit it, leave it empty for body-less POSTs such as rotate-secret or test, and Send validates JSON before calling the API.

Webhook mutations (POST / PATCH / DELETE under /api/v1/webhooks), once listed in OpenAPI, need an account-scoped key with the write scope, and Webhooks enabled on the account (canUseWebhooks). DELETE asks for confirmation. If a create or rotate response includes a signing secret, store it immediately — it is shown once.

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.

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

Section titled “Related”