Integration Models

API Integration (REST / GraphQL)

Project Green exposes a comprehensive API layer that serves as the primary integration surface for partners. The platform supports both REST and GraphQL endpoints, giving you flexibility depending on your use case and technical preferences. REST endpoints follow standard conventions with predictable URL structures, JSON payloads, and HTTP status codes, making them easy to integrate with existing tools and scripts. The GraphQL API offers a more flexible query model that allows you to request exactly the data you need in a single call, which is particularly useful for building custom dashboards or aggregating data across multiple tenants.

Authentication is handled via OAuth 2.0 with API keys available for service-to-service communication. Each partner receives a dedicated API credential set scoped to their tenant, ensuring that data isolation is maintained across the multi-tenant architecture. Rate limits are applied per credential and can be adjusted based on your tier and use case by contacting your partner manager.

Common API integration scenarios include pulling device status and health data into a partner's existing management portal, pushing alert notifications to third-party ticketing systems like ServiceNow or Jira, and synchronizing room and device inventories with asset management databases. The API documentation is available in the partner portal and includes interactive examples, SDKs for Python, JavaScript, and C#, and a Postman collection for rapid prototyping.

Partners should be aware that the API follows a versioned release cycle. Major version changes are communicated at least 90 days in advance, and deprecated endpoints remain functional for a minimum of six months after a new version is released. This policy ensures that partner integrations are not disrupted by platform updates.

White-Label Options

For partners who want to offer Project Green under their own brand, Cyviz provides a white-label program that allows extensive customization of the user-facing experience. White-labeling is available to Premium and Elite partners and covers the web dashboard, email notifications, PDF reports, and the login experience.

At a minimum, white-label partners can replace the Cyviz logo and color scheme with their own branding. More advanced customization includes custom domain hosting (e.g., monitoring.yourcompany.com), branded email templates for alerts and scheduled reports, and the ability to modify the terminology used throughout the interface to match your product naming conventions.

The white-label configuration is managed through a dedicated section of the partner portal. Changes to branding assets are applied within 24 hours and do not require any code changes on your part. For partners who need deeper customization beyond what the portal supports, Cyviz's partner engineering team can work with you on a custom theme package, which is available as an add-on service.

It is important to note that while the user-facing branding is fully customizable, the underlying platform, APIs, and support infrastructure remain managed by Cyviz. This means you get the benefit of brand ownership without the burden of maintaining the core platform. Your customers see your brand; you rely on Cyviz's engineering and operations team for reliability and updates.

Embedded Monitoring (iframe / Component)

Partners who operate their own web-based portals or management platforms can embed Project Green views directly into their existing interfaces. This integration model is designed for partners who want to offer monitoring capabilities without requiring their customers to navigate to a separate application.

The simplest approach is iframe embedding, which allows you to embed any Project Green dashboard view into your portal using a standard HTML iframe. Cyviz provides a set of embeddable URLs that are optimized for iframe use, with navigation chrome removed and responsive layouts that adapt to the container size. Authentication is handled via a token-based SSO mechanism so that users logged into your portal are automatically authenticated in the embedded view.

For a more tightly integrated experience, Cyviz offers a set of React components that can be imported directly into your frontend application. These components include device status cards, alert summary panels, room health indicators, and telemetry charts. Each component is published as an npm package and is versioned in sync with the platform API. The components accept configuration props for tenant scoping, theming, and data filtering, making them highly flexible.

Both embedding approaches support real-time data updates via WebSocket connections, so embedded views stay current without polling. Partners using the component-based approach also have access to callback hooks for events like alert firing, device state changes, and threshold breaches, allowing you to trigger actions in your own application based on monitoring events.

Partners considering the embedded approach should coordinate with the Cyviz partner engineering team during the planning phase to ensure that authentication flows, CORS policies, and content security policies are configured correctly for their environment.

Custom Plugin Development

Project Green's agent architecture supports a plugin model that allows partners to extend the platform's monitoring capabilities for specialized devices, protocols, or workflows. This is particularly relevant for partners who serve niche verticals or work with proprietary hardware that is not covered by the standard plugin library.

Plugins run within the agent's isolated execution environment, which provides a sandboxed runtime with access to a defined set of platform APIs. Each plugin can define its own data collection logic, polling intervals, and property mappings. The plugin SDK is available in TypeScript and includes a local development harness that simulates the agent runtime, allowing you to build and test plugins without deploying to a production agent.

The plugin development workflow follows a standard pattern: define a device trait (the set of properties your plugin collects), implement the collection logic using the SDK's device communication abstractions, write unit tests using the provided test harness, and submit the plugin package for review. Cyviz performs a security and quality review of all partner-developed plugins before they are approved for use in production environments.

Approved plugins are published to the plugin registry and can be scoped to your tenant or made available to the broader partner and customer ecosystem, depending on your preference. Partners who contribute plugins to the shared registry receive recognition in the partner program and may be eligible for additional incentives.

It is worth noting that plugin development requires a solid understanding of the agent architecture and device communication protocols. Partners interested in this integration model should ensure they have technically certified staff and should begin with the plugin development training module available in the partner portal.

Data Export and Reporting Integration

Many partners need to incorporate Project Green data into their own reporting workflows, business intelligence tools, or customer-facing reports. The platform supports several data export mechanisms designed to make this straightforward.

Scheduled exports allow you to configure automatic delivery of device status, alert history, uptime statistics, and telemetry summaries to an S3-compatible storage bucket, SFTP server, or email recipient. Exports can be configured in CSV, JSON, or PDF format and can be scoped by tenant, room group, or device type. Scheduling options include daily, weekly, and monthly frequencies, with the ability to define custom time windows.

For real-time data streaming, Project Green supports webhook integrations that push event data to your endpoints as it occurs. Webhooks can be configured for specific event types, such as alert state changes, device online/offline transitions, or threshold violations. Each webhook payload includes full event context, making it easy to process events in your downstream systems without additional API calls.

Partners who use business intelligence platforms like Power BI, Tableau, or Grafana can leverage the platform's read-only database replica or the GraphQL API as a data source. Cyviz provides pre-built connector templates for Power BI and Grafana that reduce setup time and ensure that queries are optimized for the underlying data model.

All data export mechanisms respect the platform's multi-tenant security model. Partners can only export data for tenants they are authorized to access, and all export activity is logged in the audit trail. If you have specific compliance requirements around data residency or retention, discuss these with your partner manager during onboarding to ensure your export configuration meets those needs.