Quickstart: first monitored API
Get to a live monitored dependency and understand where changes show up in the app. Everything here is done in the Intello web UI (after you sign in).
Before you start
- An OpenAPI 2.0 or 3.x document on HTTPS that Intello can fetch (public URL, or one your security model allows).
- You’re signed in and belong to an organization (your admin may have invited you).
Steps
1. Open Dependencies
From the sidebar, go to Dependencies (sometimes labeled Add dependency from onboarding).
2. Create the dependency
Choose Add / New dependency and fill in:
| Field | What to enter |
|---|---|
| Name | Something your team will recognize (e.g. Acme Payments API). |
| Spec URL | Direct link to the OpenAPI JSON or YAML file. |
| Base URL | Optional but helpful—the API’s root (e.g. https://api.acme.com). |
| Sync frequency | How often Intello rechecks the spec (subject to your plan). |
Save. Intello starts a sync automatically in most flows.
3. Watch the first sync
Open the dependency detail page. Find sync history / recent syncs (wording may vary):
- The first successful run stores a baseline—you might not see “changes” yet.
- After the vendor’s spec actually changes and another sync succeeds, change events appear.
If something fails, open the failed run for a short error summary, or see Troubleshooting syncs.
4. See changes
From the dependency, open the Changes tab (or use the main Dashboard / Incidents views if your workspace routes there). You can acknowledge items once triaged so the feed stays actionable.
5. (Optional) Get alerts in Slack or email
- Settings → Integrations — connect Slack, Microsoft Teams, or configure email / PagerDuty as your org allows.
- On the dependency (or subscription), adjust alert preferences so only the severities you care about notify you—see Alert preferences.
Sign-in note
You sign in with the same account your org uses (e.g. email/password or SSO via Supabase). There is nothing extra to “configure” in the docs for normal browser use.
Developers: calling the HTTP API
If you automate with scripts or internal tools, the same actions are available over /api/* with a Bearer token. That is documented in API overview and Core resources—optional for typical users.