Flip Energy API
Schemas
Copy Page
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
Schemas
Copy Page
Enrollment
Webhook - Enrollment
event_type
enum<string>
required
Allowed value:
enrollment.updated
event_object
object
(Enrollment)
read-only
required
id
string
<uuid>
Id
required
device_ids
array
[string]
required
site_id
string
required
Example:
abc-123
program_id
string
<uuid>
Program Id
required
enroll_method
enum<string>
required
Allowed values:
AUTO_ENROLL
USER_ACTION
status
enum<string>
required
Allowed values:
ACTIVE
NEEDS_ACTION
PENDING
REJECTED
UNENROLLED
status_reason
string
|
null
read-only
required
Example:
Enrollment approved by utility
enrolled_at
string
<date-time>
|
null
Enrolled At
read-only
required
unenrolled_at
string
<date-time>
|
null
Unenrolled At
read-only
required
program_specific_attributes
array
[object {2}]
required
has_agreed_to_terms_and_conditions
boolean
|
null
required
terms_and_conditions_version
string
|
null
required
Example:
2025-01-01
Your server must respond to the event with code
204
(No content).
The expected action depends on the
status
and
status_reason
content, and is typically up to the mobile application user.
Modified at
2024-07-26 08:38:44
Previous
Command
Next
Event