Add a dependency (bring your own API)
A monitored dependency is your org’s record for tracking one OpenAPI document over time. Most people add these from Dependencies in the app; this page walks through the UI first, then technical constraints and optional API details.
When to create a BYO dependency
- You have an HTTPS OpenAPI URL Intello can fetch.
- The vendor isn’t covered the way you need in the integration library, or you’re tracking a fork / internal gateway spec.
- You want per-dependency alert rules or webhooks.
If Intello already lists the vendor in the library, consider subscribing there instead of duplicating the same spec.
In the web app
- Go to Dependencies.
- Choose Add / New dependency (wording may vary).
- Enter at least:
- Name — shows in lists and alert titles.
- Spec URL — direct link to the OpenAPI JSON or YAML file.
- Base URL (optional) — helps teammates understand which service this is.
- Sync frequency — how often Intello rechecks the spec (your plan may set a minimum).
- Save. The app typically kicks off an initial sync; you can open the dependency to watch sync history and any errors.
- Use Sync now / Run sync (if shown) after you fix a bad URL or want an immediate refresh—even when automatic syncs are paused.
Enable / disable: Turn monitoring off without deleting history using the dependency’s enable/disable control (exact placement varies by UI version).
Edit: Change URL, cadence, or monitoring scope from the dependency Edit flow.
Fields (what they mean in the product)
| Concept | What it’s for |
|---|---|
| Name | Short label; appears in Slack/Teams and the dashboard. |
| Spec URL | Must be reachable HTTPS; Intello blocks unsafe hosts (see below). |
| Base URL | The API root your team thinks of (e.g. https://api.vendor.com). |
| Sync frequency | Hours between scheduled checks. |
| Full vs partial monitoring | Full = whole spec; partial = only selected domains or endpoints (when the form offers it). |
| Critical / high impact | Surfaces the dependency as higher priority in the UI where supported. |
| Per-dependency Slack/Teams URL | Optional override; prefer Settings → Integrations for org-wide OAuth when you can. |
URL validation and security
Intello’s fetch layer rejects URLs that would be unsafe in a multi-tenant service (non-HTTPS, private IPs, metadata addresses, etc.). If your spec only exists on an internal network, expose it through a public HTTPS proxy you control or ask your platform team for an approved pattern.
Avoid secrets in the URL (e.g. ?token= query params)—they leak into config, support, and logs. Prefer stable public spec URLs.
Manual vs scheduled sync
- Scheduled: Intello runs syncs automatically based on your cadence while the dependency is enabled and healthy (see Sync jobs and snapshots).
- Manual: Use Sync now in the UI after changing the URL or when you need an immediate check.
Edge cases
| Scenario | What to expect |
|---|---|
| Huge OpenAPI files | May hit size or parse limits; consider a trimmed vendor bundle. |
| Vendor republishes the same contract | No new change events until the normalized spec actually differs. |
| Auth required to download spec | May need a supported fetch/auth pattern or a proxy; see Authentication and secrets. |
Developers: HTTP API
Creating and updating dependencies via script uses POST /api/dependencies, PUT /api/dependencies/:id, POST .../sync, etc. Request/response shapes and curl examples live in Core resources.