Flip Utility APIEvents
Create event
Dispatch a demand response event to enrolled sites. Each event contains one or more actions that define what the targeted devices should do and when.
AuthorizationBearer <token>
API key passed as a Bearer token. Contact your Flip account manager to obtain credentials.
In: header
actionsarray<object>
program_idstring
Your program identifier.
target_idsarray<string>
IDs of the targets to dispatch. Interpretation depends on target_type.
target_typestring
Value in
"DEVICE" | "GROUP" | "PROGRAM" | "SITE"Response Body
curl -X POST "https://api-utility.flip.energy/v1/events" \ -H "Content-Type: application/json" \ -d '{ "actions": [ { "duration_s": 0, "mode": "CHARGE", "starts_at": "2019-08-24T14:15:22Z" } ], "program_id": "string", "target_ids": [ "string" ], "target_type": "DEVICE" }'{
"actions": [
{
"backup_reserve_percentage": 0,
"duration_s": 0,
"enable_grid_import": true,
"mode": "CHARGE",
"power_mode": "SETPOINT",
"setpoint_mode": "EVEN",
"setpoint_w": 0,
"starts_at": "2019-08-24T14:15:22Z"
}
],
"created_at": "2019-08-24T14:15:22Z",
"duration_s": 0,
"ends_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"program_id": "string",
"starts_at": "2019-08-24T14:15:22Z",
"target_ids": [
"string"
],
"target_type": "DEVICE",
"updated_at": "2019-08-24T14:15:22Z"
}{
"code": "string",
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
],
"errors": [
{
"message": "string",
"path": "string"
}
],
"message": "string",
"status_code": 0
}{
"code": "string",
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
],
"errors": [
{
"message": "string",
"path": "string"
}
],
"message": "string",
"status_code": 0
}{
"code": "string",
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
],
"errors": [
{
"message": "string",
"path": "string"
}
],
"message": "string",
"status_code": 0
}