Flip Energy API
  1. Schemas
Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • End-user app design
  • Monitoring / Telemetry
  • Control
  • Change log
  • Mobile App API
    • Devices
      • Create Device
      • Read Devices
      • Read Device
      • Update Device
      • Delete Device
    • Enrollments
      • Create Enrollment
      • Read Enrollments
      • Read Enrollment
      • Delete Enrollment
    • Events
      • Read Events
      • Read Event
      • Update Event Participation
    • Programs
      • Read Programs
      • Read Program
    • Sites
      • Read Site
      • Update Site
  • Cloud API
    • Sites
      • Get Site Token
      • Get Sites
    • Commissioning
      • Commission Site And Devices
    • Sessions
      • Sessions
    • Commands
      • Command Created
      • Update Command Status
    • Programs
      • Read Programs
    • Telemetry
      • Report Battery Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  1. Schemas

Event

Webhook - Event
event_type
enum<string> 
required
Allowed values:
event.canceledevent.created
event_object
object (Event) 
required
id
string <uuid>
read-onlyrequired
program_id
string <uuid>
required
site_id
string 
required
Example:
abc-789
starts_at
string <date-time>
read-onlyrequired
Time at which the event starts.
Example:
2025-04-30 12:00:00.000Z
ends_at
string <date-time> | null 
read-onlyrequired
Time at which the event ends. If null, the event will continue until the utility sends a termination signal.
Example:
2025-04-30 14:00:00.000Z
duration_s
number  | null 
required
Duration of the event, in seconds. If null, the event will continue until the utility sends a termination signal.
Example:
7200
schedule
array [object {6}] 
required
Use this to build a schedule for the event to show the end-user. Not enough information is provided here to send instructions to devices. Please use Commands instead.
device_settings
array[object (EventBatterySettings) {3}] 
deprecated
Settings per device for the event.
status
enum<string> 
read-onlyrequired
Allowed values:
ACTIVECANCELEDCOMPLETEDUPCOMING
is_participating
boolean 
required
created_at
string <date-time>
read-onlyrequired
updated_at
string <date-time>
read-onlyrequired
Your server must respond to the event with code 204 (No content).
To update the participation parameters, extract the dispatch ID from the dispatches array in the event_object object, and then use Update Dispatch.
Modified at 2024-07-26 08:38:51
Previous
Enrollment
Built with