API Reference
Start typing to search…

Trigger test group notification

post
https://api.staging.leap.energy/v2/dispatch/group/webhook/integration_test

Create test notification that will trigger a webhook call with the corresponding group dispatch notification data

Body Params

Test group dispatch notification

group_dispatches
array of objects
required
length ≥ 1

List of market group events

group_dispatches*
uuid
required

The id of the market group that received dispatches from the market.

meter_ids
array of uuids
required

Ids of the meters that received dispatches from the market

meter_ids*
partner_references
array of strings

The partner-supplied reference IDs to help identify the customer or site that a Leap meter correlates to a partner’s internal systems.

partner_references
timeslots
array of objects
required
length ≥ 1

List with timeslots and quantities that contains dispatches for this market group

timeslots*
uuid
required

Unique identifier of the market group dispatch event

date-time
required

Start time of dispatch

date-time
required

End time of dispatch

boolean
required

'true' if this event has been cancelled

double
0.01 to 100000

The awarded kW for the dispatch. This represents the expected power in kW to be curtailed/exported for the duration of the event. If the value is 'null' partners should dispatch the maximum they can manage.

double
0.01 to 100000

The nomination in kW. It represents the commitment amount made to the market for this asset.

string
enum
required

This field can be used to automate a dispatch response that is aligned with the event’s settlement structure, to capitalize on scenarios where over-performance is lucrative versus scenarios where over-performance is not compensated and best reserved for another event.
- UpToNomination - If partners dispatch beyond their nomination value, they will not be compensated.
- UpToSiteLoad - Partners will be compensated for dispatching up to a site load of 0 kW.
- GridExportsAllowed - Partners will be compensated for dispatching beyond a site load of 0 kW, into negative site load.

Allowed:
integer
required
1 to 10

The priority of the dispatch compared to other dispatches for the same meter. This value is meant to support partners in prioritizing dispatch events in same-day or overlapping scenarios, at times where the asset may not be able to perform across all events. Number 1 reflects the highest priority.

boolean
required

Indicates whether the dispatch is voluntary or a commitment. Pay-for-performance events, with no energy commitment to achieve, are categorized as true. If a dispatch event constitutes a market or program commitment or carries partner penalties for non-performance, this is set to false.

dispatch_event_types
array of objects
required
length ≥ 1

Used for programs that have different compensation structures for different types of dispatch events. All programs with a single compensation structure for all events will be set to standard.

programs
array of objects
required
length ≥ 1

Programs associated with the dispatch. This is a fixed list of values depending on your use-case and refers to the program(s) that the meters are enrolled in.

Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago