Home › Integrations › Public API and webhooks
Public API & Signed Webhooks
Where there is no ready-made integration, Energy Connect's public REST API and signed webhooks are how your own system reads and writes the same orders, invoices, prices and documents the portals use.
That is what lets an order accepted once in Energy Connect reach every connected system. The API and webhooks provide the connection; the integration on your side still has to be built.
The API
- Base URL:
https://api.energyconnecter.ai/v1/public, JSON over HTTPS. - API keys are prefixed
ec_live_for production andec_test_for the sandbox, and are sent as anX-API-Keyheader or a bearer token. Each key carries scopes, and sees only the data its company is allowed to see. - Idempotent writes. Writes take an
Idempotency-Keyheader. Retrying with the same key and body returns the original response instead of doing the work twice. - A published contract. The OpenAPI document at
https://api.energyconnecter.ai/openapi.jsonis the machine-readable source of truth.
Webhooks
- Signed. Each delivery carries an
X-EC-Signatureheader: an HMAC-SHA256 of the timestamp and raw body, using your subscription's secret. - Thin payloads. A webhook carries ids and an event type, not the record. Your system fetches the record through the API, so it sees exactly what its key is allowed to see.
- At least once. Failed deliveries are retried on a backoff schedule. Each event has a stable id to deduplicate on, and missed events can be replayed.
Where to start
The getting started guide walks through issuing a key, running a haul and subscribing to webhooks. The API reference lists every endpoint.
Intuit and QuickBooks are registered trademarks of Intuit Inc. Microsoft, Business Central and Dynamics 365 are trademarks of the Microsoft group of companies. Trimble and TMW are trademarks of Trimble Inc. Sage is a trademark of The Sage Group plc. Oracle, Java, MySQL, and NetSuite are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Energy Connect is not affiliated with, endorsed by or approved by these companies.