API Integration
Route: /org/resolve/settings?tab=api_integration
Permission: Allows viewing Integration Telemetry charts and settings — managing keys needs …integration.manage
1. What it does
Issues REST credentials so an external system can raise and update tickets, and shows the ingress log of what those credentials actually did.
Unlike the other fifteen, this one is gated on Allows viewing Integration Telemetry charts and settings. A user without it sees 15 tabs, not 16 — nothing is broken.
2. How it spreads
3. Creating a credential
| Field | Control | Notes |
|---|---|---|
| Key Description/Name | Text | Placeholder e.g. Migration Script / Zapier. Name it after the consumer |
| Rate Limit (Requests/Min) | Number | Per-key throttle |
| Expiration Policy | Selector | Includes Never Expires |
| Bypass Expiry / Migration Bypass | Toggle | For one-off migrations |
Copy API Credentials reveals the key.
Copy it at creation. If it is lost, issue a new one and revoke the old — there is no way to re-reveal it.
A non-expiring key outlives the integration, the vendor and the person who created it. Prefer an expiry and a calendar reminder; reserve Never Expires for things you actively monitor.
4. Active Credentials
| Column | Holds |
|---|---|
| Key Name | What you called it |
| Key Identifier | The public prefix — safe to quote in a ticket |
| Rate Limit | Requests per minute |
| Migration Bypass | Whether expiry is bypassed |
5. Payload structure & code guides
Ready-made snippets in cURL, Python, Node.js and Go for the ingress endpoint — copy, substitute your key, and you have a working integration.
6. Recent Ingress API Hit Logs
Every inbound call: Hit Time · Client IP · Ingress Request · Latency · Detailed Status Message. Search Logs (IP/Path)… filters it.
It distinguishes three very different failures: the call never arrived (nothing logged), arrived and was rejected (status message), or arrived and succeeded but created something unexpected. Check here before debugging the sender.
7. Don't confuse this with…
| These two | Differ by |
|---|---|
| API Integration vs Integration Telemetry | Managing keys and raw logs vs charted health over time |
| API key vs fulfilment webhook | Inbound to Orbit vs outbound from Orbit |
| This tab vs ChatOps | REST vs chat platforms |
8. Troubleshooting
| Symptom | Cause |
|---|---|
| 401 from the API | Key revoked, expired, or the identifier is being sent instead of the key |
| 429 | Over the per-key rate limit |
| Nothing in the ingress log | The call never reached Orbit — check the sender |
| Key lost | Issue a new one; it cannot be re-revealed |