Build an integration¶
Use a typed client when one fits your application, or call the HTTP API directly. The same server-side permissions and limits apply to every interface.
Recommended reading order¶
- Core concepts and first API requests.
- Authentication, service accounts, and scoped tokens.
- Queries and cursor pagination, including the endpoint support matrix.
- Revisions and conditional mutations for safe updates.
- Tasks for asynchronous operations and retained outputs.
Choose a workflow¶
| Integration goal | Server contract |
|---|---|
| Synchronize an inventory graph | Import API, including idempotency and per-item results |
| Extract data or render a report | Export API and template guide |
| Discover and traverse related resources | Search and relationships |
| Send chat or notification messages | Slack, Mattermost, Discord, and notification bridges |
| React to changes | Events, sinks, and subscriptions |
| Invoke an external system for an object | Remote targets |
| Update selected JSON fields | Atomic JSON Patch |
| Manage credentials or restore data | Credential approvals and restore workflow |
Treat a submitted task as pending work until its terminal status and results confirm success. Honor output retention, request limits, and pagination rather than assuming all results arrive in one response.
For a new release, review the compatibility records and the server's integration coverage.