GET
/
entities
/
webhooks
/
dispatch
/
example
/
{asset_id}
curl --request GET \
  --url http://localhost:8001/entities/webhooks/dispatch/example/{asset_id}
{
  "asset_id": "<string>",
  "event_id": "<string>",
  "issued_timestamp": "2023-11-07T05:31:56Z",
  "event_timestamp": "2023-11-07T05:31:56Z",
  "market_id": "<string>",
  "level_kw": 123,
  "from_time": "2023-11-07T05:31:56Z",
  "to_time": "2023-11-07T05:31:56Z",
  "update_status_callback": "<string>"
}

Verifying the source of dispatch events

This example dispatch event is signed with the secret key JUq8Br7UF5Wb5AP6eYD2

You can verify that the X-Axle-Signature included in the header is valid by computing the sha256 HMAC of the event_id with the secret key. Here’s an online checker you can use to do so.

You can specify your own secret when you register your webhook.

Custom headers are stripped in the interactive API playground, so it’s best to test this endpoint with the cURL command displayed on the right.

Path Parameters

asset_id
string
required

Response

200 - application/json
asset_id
string
required

Asset or aggregate to which this event pertains

event_id
string
required

UID of this event

issued_timestamp
string
required

When the event was published (UTC)

event_timestamp
string

When the event occurred, if different from publication (UTC)

market_id
string
required

Market from which this dispatch originates

level_kw
number
required

Desired power output of asset

from_time
string
required

Start time of event (UTC)

to_time
string
required

End time of event (UTC)

update_status_callback
required

Callback to change status of event to RECEIVED, ACCEPTED, REJECTED, FAILED, or EXECUTED