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

Enrollment

Webhook - Enrollment
event_type
enum<string> 
required
Allowed value:
enrollment.updated
event_object
object (Enrollment) 
read-onlyrequired
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_ENROLLUSER_ACTION
status
enum<string> 
required
Allowed values:
ACTIVENEEDS_ACTIONPENDINGREJECTEDUNENROLLED
status_reason
string  | null 
read-onlyrequired
Example:
Enrollment approved by utility
enrolled_at
string <date-time> | null 
Enrolled At
read-onlyrequired
unenrolled_at
string <date-time> | null 
Unenrolled At
read-onlyrequired
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.
Previous
Command
Next
Event
Built with