Developers
Build on Orqit with a documented public API
API keys, scopes, rate limits, pagination, and HMAC-signed webhooks—with examples you can run today.
Overview
Orqit’s developer surface is the public REST API, API key management, webhook subscriptions, and in-product examples—not a separate published language SDK package catalog.
Audience
Who this is for
- Software engineers extending Orqit
- MSP automation teams
- Internal platform teams wiring Orqit into existing stacks
Challenges
Problems we address
-
Fragile custom code Lack of clear extension patterns leads to brittle integrations.
-
Environment setup friction Inconsistent local dev setup slows every project kickoff.
-
Security uncertainty Unclear best practices for tokens, scopes, and data privacy.
Context
How Orqit approaches this
Start with API keys and scopes in the admin developer portal, call /api/public/v1 resources documented at /developers/api, and subscribe to outbound webhooks with HMAC verification. Language samples (cURL, JavaScript, Python, Java) ship in the docs—use them as starters rather than assuming published SDK packages.
Capabilities
Platform capabilities
Public API documentation, webhook events, and practical examples for engineers extending Orqit.
Public API docs
Auth, rate limits, pagination, errors, and resource guides.
API keys & scopes
Least-privilege keys managed in the developer portal.
Webhooks
ticket.*, asset.created, and task.updated with signature verification.
Examples
Copy-paste samples for common automation jobs.
Security guidance
Token handling, scopes, and tenant isolation basics.
Workflow
How it works in practice
-
1
Custom Webhook
Receive external events and push into Orqit workflows.
-
2
UI Widget
Add a custom dashboard panel showing external KPIs.
-
3
Automation Action
Plugin performs cloud resource cleanup on trigger.
-
4
Marketplace App
Package extension and submit to the partner marketplace.
Outcomes
Results teams care about
Ship faster
SDKs and templates reduce integration development time.
Stay compliant
Security standards built into every extension path.
Iterate safely
Sandbox and CI/CD enable rapid, confident releases.
Governance & security
Built for audit and least-privilege
- All extensions must be signed and reviewed before production deployment.
- Permissions are scoped per extension via RBAC.
- Audit logs capture calls made by extensions for traceability.
AI usage
Co-pilot within your guardrails
AI suggests code snippets based on described functionality and can auto-generate API request scaffolding.
Analytics
Operational visibility
Developer portal tracks extension usage, error rates, and performance metrics.
FAQ
Common questions
How do I publish an extension?
Follow the Marketplace Publishing Guide; extensions are reviewed for security before being listed.
Can I test against real production data?
Tests should run in sandbox; production access requires explicit approval.
Next step
Ready to modernize IT operations?
Launch a pilot workspace or book a walkthrough — with estimated seat savings versus legacy suites, plus 24/7 support.
Entity graph