| Time | Status | User Agent | | | :-- | :-- | :-- | :-- | | Make a request to see history. | #### URL Expired The URL for this request expired after 30 days. > ✅ > > ### Dispatch Examples per Program [Skip link to Dispatch Examples per Program](https://developer.leap.energy/reference/triggertestgroupdispatchnotification#dispatch-examples-per-program) > > An example dispatch event notification for most programs can be found within the `EXAMPLES` dropdown menu in the black REQUEST box on the right panel of this page. For more details on how to use these examples, see the [Test Cases](https://developer.leap.energy/docs/event-processing-test-cases) developer guide. Test group dispatch notification **group_dispatches** array of objects required length ≥ 1 List of market group events **group_dispatches*** object Aggregates timeslot dispatches per market group. Previously stored dispatches might be updated so when dealing with a dispatch timeslot that has the same market_group_event_id as an existing one, the previously received dispatch has to be updated with the new field values. - **market_group_id** 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 - **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. - **timeslots** array of objects required length ≥ 1 List with timeslots and quantities that contains dispatches for this market group - **timeslots*** object A single dispatch interval that describes all aspects of the dispatch. - **market_group_event_id** uuid required Unique identifier of the market group dispatch event - **start_time** date-time required Start time of dispatch - **end_time** date-time required End time of dispatch - **cancelled** boolean required 'true' if this event has been cancelled - **energy_kw** 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. - **nomination_kw** double 0.01 to 100000 The nomination in kW. It represents the commitment amount made to the market for this asset. - **performance_compensation_cap** 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. - **priority** 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. - **is_voluntary** 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. # `` 200 Successfully triggered a test group notification to be sent to the registered group webhook url object Dispatch notification successfully sent to webhook URL during an integration test - **http_status** integer The http code from the response server for the webhook URL or 'null' if no response was received - **sent_time** date-time required Time when the request was sent - **received_time** date-time Time when the response was received - **headers** object Http headers received from the server - **body** string Http body received from the server if present (so either a Meter Event Notification or Market Group Event Notification), 'null' otherwise - **error_message** string In case the request to the webhook URL failed this field contains a description of the failure # `` 400 Request could not be parsed or is invalid # `` 401 Unauthorized # `` 403 No access to this resource # `` 404 Resource not found # `` 5XX Unexpected error Updated 11 months ago --- Base URL https://api.staging.leap.energy/v2/dispatch/group/webhook/integration_test ``` xxxxxxxxxx curl --request POST \ \ --url https://api.staging.leap.energy/v2/dispatch/group/webhook/integration_test \ \ --header 'accept: application/json' \ \ --header 'content-type: application/json' \ \ --data '\n\n{\n\n "group_dispatches": [\ \ {\ \ "timeslots": [\ \ {\ \ "cancelled": true,\ \ "performance_compensation_cap": "grid-exports-allowed",\ \ "is_voluntary": true,\ \ "dispatch_event_types": [],\ \ "programs": []\ \ }\ \ ]\ \ }\ \ ]\ \n}\n\n' ``` ``` xxxxxxxxxx { "sent_time": "2023-01-23T04:56:07.000Z", "headers": { "key": [\ "x-api-key",\ "your-key" ] }, "http_status": 200, "received_time": "2023-01-23T04:56:17.000Z", "body": "body that is echoed" } ``` Updated 11 months ago