How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Voltus Webhooks API

Register HTTP callbacks so Voltus can push dispatch notifications instead of the partner polling. Documented operations are GET /webhooks ("Returns a list of all webhooks that have been created."), POST /webhooks and DELETE /webhooks/{id} ("Permanently deletes a webhook. It cannot be undone.").

Voltus Webhooks API is one of 5 APIs that Voltus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook, Dispatch, and Notification. The published artifact set on APIs.io includes an API reference, API documentation, and an OpenAPI specification.

This API exposes 10 operations across 8 paths, organized into 4 resource areas. It is described by OpenAPI 3.0.3, at version 2022-04-15.

Requests are made against a single base URL, https://api.voltus.co.

10 operations 8 paths 0 schemas 1 DELETE5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2022-04-15
Base URL
https://api.voltus.co/2022-04-15
Authentication
API Key
Resource Areas
4

Authentication & Security 1

Voltus Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Voltus-API-Key (X-Voltus-API-Key). By default, every request must be authenticated.

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 4 POST. They span 4 resource areas: Dispatches, Sites, Telemetry, Webhooks. Each is listed below with its method, path, parameters, and response codes.

Dispatches 3
POST
/2022-04-15/dispatches
Creates a test dispatch. Create a new dispatch object. Upon sending a successful request, a new dispatch object will be persisted. The new dispatch will be returned in the response to GET /dispatches…
voltus#post-dispatch 1 param body → 200400403404413429500
GET
/2022-04-15/dispatches
Returns a list of dispatches. By default, the list dispatches endpoint returns all dispatch events from the previous 24 hours. This endpoint is commonly used to implement a polling pattern to listen…
voltus#get-dispatches 1 param → 200400403404413429500
GET
/2022-04-15/dispatches/{id}
Retrieves the dispatch with the given ID. Can be used to explicitly check for the status of an individual dispatch.
voltus#get-dispatch 2 params → 200400403404413429500
Sites 1
GET
/2022-04-15/sites
Returns a list of your sites. The sites endpoint is important because a given API key will only get dispatch notifications that include sites visible to the account. You should make sure that all exp…
voltus#get-sites 1 param → 200400403404413429500
Telemetry 3
POST
/2022-04-15/telemetry
This endpoint is intended for bulk-data submission and can receive many telemetry points in the same request. You can also post non-contiguous intervals, intervals for multiple meters, and intervals…
voltus#post-telemetry 1 param body → 200400403404413429500
POST
/2022-04-15/telemetry/controllable-load
Posts controllable load. Controllable load is an estimated kW value based on the nameplate energy usage (or actual energy usage) of equipment currently under the control by your integration’s softwar…
voltus#post-controllable-load 1 param body → 200400403404413429500
GET
/2022-04-15/telemetry/kw
Returns a list of telemetry readings for one or more sites. The maximum number of sites per request is 10. The maximum request interval is 90 days, with a limit of 10,000 total data points per site.…
voltus#get-telemetry-kw 5 params → 200400403404413429500
Webhooks 3
GET
/2022-04-15/webhooks
Returns a list of all webhooks that have been created. All webhooks will be returned in a single request. The values of page and perpage have been reserved for future use, but should be ignored at pr…
voltus#get-webhooks 1 param → 200400403404413429500
POST
/2022-04-15/webhooks
Create a webhook by providing the events you'd like to listen for, and the URL where you'd like to receive notifications. When a webhook is created, we will send a test request to the provided URL wi…
voltus#post-webhook 1 param body → 200400403404413429500
DELETE
/2022-04-15/webhooks/{id}
Permanently deletes a webhook. It cannot be undone.
voltus#delete-webhook 2 params → 200400403404413429500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

voltus-openapi.yml Raw ↑

Other APIs Voltus publishes across the network.

Voltus Dispatches API
Voltus Sites API
Voltus Telemetry API
Voltus OpenADR 2.0a VTN
Where this information came from

This is an independent, third-party profile of Voltus Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.