MosVPP Partner Integration Overview
This document provides a unified overview of the MosVPP partner integration APIs. Molecule Systems exposes several REST and webhook interfaces that allow partners to:
- Submit dispatch requests
- Receive execution responses
- Receive real-time data pushes
- Synchronize device lists
- Submit site-level commands
Each API is documented in its own page. This index links to all of them and explains how they fit together.
Available API Documents
Dispatch Request API
Page: Demand Response - Webhook
Partners send dispatch requests to Molecule using a secure HTTPS endpoint. Molecule validates the request and responds with a receipt. Once the event is executed, Molecule sends an execution response webhook back to the partner.
This document includes: dispatch request payload structure, event field definitions, authentication requirements, execution response webhook, and best practices.
Data Push Webhook
Page: Data Push - Webhook
Molecule pushes real-time or near-real-time operational data to a partner-hosted webhook. This includes telemetry, device health, and multi-device metrics.
This document includes: data push webhook endpoint, multi-device payload structure, authentication requirements, delivery expectations, and sample payloads.
Device Sync API
Page: Device Sync - Endpoint
Partners can retrieve the full list of devices associated with a Molecule site or controller. This endpoint is used for onboarding, reconciliation, and device capability discovery.
This document includes: device sync endpoint, device object structure, device sub-type codes, and sample responses.
Site Command API
Page: Site Command - Webhook
Partners can send site-level commands to control downstream devices such as inverters, relays, and thermostats. Molecule responds with a receipt confirming acceptance. This API is independent of the DR workflow.
This document includes: site command payload structure, downstream device command fields, authentication requirements, and sample requests and responses.
Integration Lifecycle
Below is the typical flow for partners integrating with MosVPP:
1. Device Synchronization
Partner calls the Device Sync API to retrieve the list of devices and their capabilities. → Device Sync - Endpoint
2. Dispatch Request Submission
Partner sends dispatch events to Molecule. → Demand Response - Webhook
3. Receipt from Molecule
Molecule responds immediately with an acceptance receipt.
4. Execution Response Webhook
Once the event is executed, Molecule sends a webhook to the partner with execution status. → Demand Response - Webhook
5. Real-Time Data Push
Molecule pushes telemetry and operational data to the partner's data webhook. → Data Push - Webhook
6. Site Commands
Partner sends site-level commands to control downstream devices. → Site Command - Webhook