Overview

This guide is designed for Enerflo Partners building custom integrations with the Enerflo platform using Enerflo's APIs and Webhook Events. We'll walk through common business use cases and best practices to help make the integration more approachable. Not every stage will apply to every use case — review each one and implement what's relevant to your objectives.

⚠️ This guide covers the Enerflo side of the integration — data exchanges, endpoints, and events. CRM-specific connectors, field mapping, and surrounding business logic are outside its scope and are left to your team.

💡 If you're interested in engaging Enerflo's Professional Services team for a custom integration, please reach out to Enerflo Support to schedule a free discovery conversation.

Before You Begin

Before starting your integration, make sure you have the following in place:

• Enerflo API credentials — You'll need an API key to authenticate REST API requests. Contact Enerflo Support if you don't have one yet.
• Webhook Event Subscription — Any outbound data flow (Enerflo → 3rd-party) requires an active webhook subscription. See Enerflo 1.0 Events or Enerflo 2.0 Events to set one up.
• A middleware or integration platform (optional but recommended) — Tools like Zapier, Make, or a custom service can simplify data mapping and transformation between Enerflo and your CRM.
• Familiarity with your CRM's API — This guide covers the Enerflo side only. Your team will need to handle the corresponding CRM-side logic.

New integrations should use Enerflo 2.0 Events where available. v1 events are still supported but v2 events offer richer payloads and improved reliability. Each stage below notes which version applies.

Integration Flow

The six stages below represent the full lifecycle of a solar project — from lead capture through change orders. They are designed to be implemented independently, so you only build what your use case requires.

flowchart LR
    S1[Stage 1: Leads] --> S2[Stage 2: Project Submission]
    S2 --> S3[Stage 3: Milestones]
    S3 --> S4[Stage 4: Statuses]
    S4 --> S5[Stage 5: Notes]
    S5 --> S6[Stage 6: Change Orders]

Which Stages Do I Need?

Use the table below to identify which stages are most relevant to your integration scenario.

Glossary of Common Stages

Stage 1: Leads

1.1) 3rd-party >> Enerflo

Example request body:

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "5551234567",
  "address": "123 Solar Way",
  "city": "San Diego",
  "state": "CA",
  "zip": "92101"
}

Fields shown are illustrative. See the full endpoint documentation for all available fields and requirements.

1.2) Enerflo >> 3rd-party

Example event payload:

{
  "webhook_event": "new_customer",
  "id": 2860314,
  "external_id": null,
  "first_name": "Test",
  "last_name": "RCustomer",
  "full_name": "Test RCustomer",
  "email": "[email protected]",
  "phone": "(000) 000-0000",
  "address": {
    "street": "123 Example St",
    "city": "Sample City",
    "state": "EX",
    "zip": "12345",
    "county": "Example County",
    "full_address": "123 Example St, Sample City, EX 12345",
    "latitude": 12.345678,
    "longitude": -98.765432
  },
  "customer_timezone": "America/Chicago",
  "lead_source": "",
  "timestamps": {
    "deleted_at": null,
    "created_at": "2025-01-14 15:47:29",
    "updated_at": "2025-01-14 15:47:29",
    "timezone": "UTC"
  }
}

See the Enerflo 1.0 Events documentation for the full payload schema.

Stage 2: Enerflo Project Submission & Resubmission

When a deal in Enerflo satisfies all submission requirements and is submitted by a user, Enerflo fires project submission events. This stage covers how to receive those events and push the project data to your CRM.

Example event payload (deal.projectSubmitted):

{
  "event": "deal.projectSubmitted",
  "payload": {
    "targetOrg": "88888888-0e5f-4996-8f74-28c75ddb48b9",
    "initiatedBy": "296af00b-3c04-45bd-82a4-a2ece88171eb",
    "deal": {
      "id": "59886cce-2504-4da8-b63a-25b088e97b46",
      "shortCode": "b9sqedcvp",
      "state": {
        "hasSubmittedProject": true,
        "hasApprovedDesign": true,
        "hasCreatedProposal": true
      }
    },
    "customer": {
      "id": "f6ac5e81-ef2d-4981-863a-86bbb4590601",
      "firstName": "Firsty",
      "lastName": "Lasty"
    }
  }
}

Example hydration request (Step 3):

GET /api/v3/installs/find/59886cce-2504-4da8-b63a-25b088e97b46

See the Enerflo 2.0 Events documentation for the full payload schema, including deal.projectReceived.

Stage 3: Updating Install Project Milestones

A project milestone is a specific checkpoint in an install project that marks progress toward completion. A milestone is associated with key dates (such as a start date, due date, and a completion date). Multiple milestones can be active simultaneously, each tracking an essential step within the project timeline.

3.1) 3rd-party >> Enerflo

Example request body:

PUT /api/v3/installs/67890/milestones/3

{
  "completed_date": "2024-08-15"
}

Only pass the fields you intend to update. The endpoint accepts partial updates.

3.2) Enerflo >> 3rd-party

Example event payload:

{
  "body": {
    "sales_milestone": [],
    "install_milestone": {
      "id": 1234,
      "sequence": 1,
      "title": "Project Submitted",
      "description": "Initial milestone indicating the project has been submitted.",
      "assigned_user": null
    },
    "details": {
      "id": 56789,
      "install_id": 4453459,
      "title": "Project Submitted",
      "completed_on": "2024-09-30",
      "estimated_completion_date": null,
      "start_date": null,
      "updated_at": "2024-09-30 13:58:09"
    },
    "eventName": "project_milestone_updated"
  }
}

See the Enerflo 1.0 Events documentation for the full payload schema, including the nested install object.

Stage 4: Updating Install Project Statuses

An Install Project's status reflects its overall lifecycle state in Enerflo. Common statuses include Active, On Hold, and Completed. This stage covers keeping that status synchronized between Enerflo and your CRM in both directions.

4.1) 3rd-party >> Enerflo

Example request body:

PUT /api/v3/installs/67890/

{
  "status_id": 5
}

4.2) Enerflo >> 3rd-party

Example event payload:

{
  "body": {
    "id": 4453459,
    "epc_company_id": 1234,
    "company_id": 1234,
    "status_id": 4,
    "created_at": "2024-08-09 15:31:41",
    "updated_at": "2024-08-09 15:31:41",
    "deleted_at": null,
    "agreement_url": "https://s3-us-west-2.amazonaws.com/assets.enerflo.io/agreements/agreement.pdf",
    "customer": { "...": "see full customer object in event docs" },
    "eventName": "update_install"
  }
}

Stage 5: Updating Install Project Notes

Project notes allow teams to leave contextual comments on an install project. This stage covers keeping notes synchronized between Enerflo and your CRM so all stakeholders have visibility regardless of which system they're working in.

5.1) 3rd-party >> Enerflo

Example request body:

POST /api/v3/installs/67890/notes

{
  "body": "[From Sarah Johnson in Salesforce]: Customer confirmed roof access is available starting Aug 20."
}

5.2) Enerflo >> 3rd-party

Example event payload:

{
  "webhook_event": "new_install_note",
  "id": 2626212,
  "note": "Permitting approved. Ready to schedule installation.",
  "has_file": false,
  "file": null,
  "user_id": 40773,
  "install_id": 4453459,
  "deal_id": 2459008,
  "milestone_id": null,
  "is_complete": false,
  "timestamps": {
    "deleted_at": null,
    "created_at": "2025-01-14 18:48:54",
    "updated_at": "2025-01-14 18:48:54",
    "timezone": "UTC"
  }
}

Stage 6: Change Orders

A Change Order modifies the terms of an existing signed agreement — for example, updating panel type, count, battery configuration, or adders. Change Orders are always initiated and signed within Enerflo, so this stage only covers the outbound direction (Enerflo → 3rd-party). There is no inbound API path to create a Change Order from an external system.

Example event payload:

{
  "body": {
    "id": 6543210,
    "status": "complete",
    "status_id": 4,
    "install": { "...": "see full install object in event docs" },
    "change_orders": [ { "...": "see change_orders array in event docs" } ],
    "signer": { "...": "signer details" },
    "change_values": { "...": "before/after values for updated fields" },
    "created_at": "2024-08-07 23:59:41",
    "signed_at": "2024-09-16 18:40:42",
    "pdf_url": "https://assets.enerflo.io/docflo_pdfs/executed/change_order.pdf",
    "eventName": "signed_change_order"
  }
}

See the Enerflo 1.0 Events documentation for the full payload schema.