Webhooks

Register a callback URL to receive HTTP notifications when projects are created, contracts are signed, comments are added, and other subscribed events occur. Use these real-time notifications instead of polling.

Use V2 for new subscriptions. Existing integrations can consult V1 signing and all event payload examples.

Looking for the shape of each event? Jump straight to Event payload examples.

How delivery works

Queued delivery keeps your endpoint from slowing Artemis. Every attempt is logged.

Configuration

Configure webhooks in Installer Settings → Developer → Webhooks. For each subscription you set:

  • Callback URL: the HTTPS endpoint that receives events.
  • Contract version: new subscriptions use V2. Existing V1 subscriptions can still be edited and tested; new V1 subscriptions cannot be created. application-decision is V1-only.
  • HTTP method: V2 always uses POST.
  • Event types: one or more events to subscribe to.
  • Authentication: how Artemis proves the request is genuine (see below).
  • Active: toggle delivery on or off without deleting the subscription.

Manage V2 subscriptions through /external/v2/webhook-subscriptions; see API Reference v2. REST and webhook versions are independent; V1 subscriptions are not migrated automatically.

Use the Test Webhook action to send a sample payload for your selected events at any time.

Payload structure

V2 payloads

V2 sends id, event, version: 2, createdAt, and resource instead of the full model. Design Help events identify the request with resource.type: "design-help" and resource.id equal to the Design Help ID returned when requesting assistance. Their resource.href points to /external/v2/projects/{projectId}/design-help/{designHelpId}, where you can read the current state and lifecycle timestamps. Other project-related events point to /external/v2/projects/{projectId}. User events point to /external/v2/users/{userId}. After user-deleted, the resource may no longer be available. Deduplicate deliveries by event id.

contract-signed also sends data.contractUrl, a signed link to the executed contract PDF that expires in 24 hours. It is omitted when the signed PDF is not available. No other V2 event has data. After the link expires, list GET /external/v2/projects/{projectId}/documents, find the signed PDF in the Contracts folder, and read it with GET /external/v2/projects/{projectId}/documents/{documentId} for a fresh downloadUrl. The file can appear a few moments after the webhook.

Use the Contract Version selector under Payload Examples in Installer Settings to see examples for the events supported by each version. application-decision is available only in V1.

Asynchronous project creation

POST /external/v2/projects returns 201 as soon as the project is saved. For this asynchronous flow, project-created is dispatched after initial setup finishes, including when setup fails after its retries. It does not guarantee a successful design. Subscribe before creating projects, then follow resource.href and check autoDesignStatus: completed or failed. Read /design for design results. Use occasional polling as a fallback if a notification is delayed or missed.

V2 authentication & signing

V2 always uses HMAC-SHA256. Verify X-Artemis-Webhook-Signature as v1= followed by the hex digest of HMAC-SHA256(secret, timestamp + "." + rawBody), using X-Artemis-Webhook-Timestamp. Enforce a replay window and compare in constant time. X-Artemis-Webhook-Id contains the event ID. Timestamps are Unix seconds. When creating a subscription through REST, securely store data.signingSecret from the creation response; reads omit it. For a secret you configure yourself, use a random value of at least 32 characters.

This Node.js example accepts the raw body as a Buffer and a five-minute replay window. Synchronize your server clock. Run signature verification before parsing JSON or acknowledging the delivery.

import { createHmac, timingSafeEqual } from 'node:crypto'

function verifyV2Signature(rawBody, timestamp, signature, secret, now = Date.now()) {
  if (!/^\d+$/.test(timestamp ?? '')) return false
  if (!/^v1=[a-f0-9]{64}$/.test(signature ?? '')) return false
  const timestampSeconds = Number(timestamp)
  if (!Number.isSafeInteger(timestampSeconds)) return false
  if (Math.abs(Math.floor(now / 1000) - timestampSeconds) > 300) return false

  const expected = createHmac('sha256', secret)
    .update(`${timestamp}.`)
    .update(rawBody)
    .digest()
  const received = Buffer.from(signature.slice(3), 'hex')
  return timingSafeEqual(expected, received)
}

Pass the X-Artemis-Webhook-Timestamp and X-Artemis-Webhook-Signature header values to this function. Do not use JSON.stringify on a parsed request to recover the body: whitespace and serialization changes invalidate the signature.

The external V2 subscription API accepts customHeaders on create and update. Reads return customHeaderNames; values are write-only. Send {} to remove all custom headers, or omit the field to preserve them. Transport and signature headers cannot be overridden. Deleting a subscription disables it and removes its credentials.

Delivery, retries & logs

Your endpoint should acknowledge quickly with a 2xx and do heavy work asynchronously. Each request has a 30-second timeout.

OutcomeRetried?
2xx successNo, marked success
5xx server errorYes, exponential backoff
Timeout (>30s) or network errorYes, exponential backoff
4xx client errorNo, marked failed (your endpoint rejected it)

Every attempt is written to a delivery log with a status of pending, success, or failed, plus the response status code and body (truncated). View logs in Installer Settings → Developer. Delivery logs are not exposed through the public v1 or v2 API.

Delivery logs are retained for 7 days, after which they are automatically deleted.

Event catalog

Subscribe to any combination of the following events.

Project events

EventFires when
project-createdA project is created
project-updatedA project is updated
proposal-sentA proposal is emailed to a customer. V1 includes proposalSentTo; V2 identifies the project
pre-sale-status-updatedThe proposal status changes during the pre-sale phase
post-sale-status-updatedThe proposal status changes during the post-sale phase (permitting, installation, completion)

Design help events

EventFires when
design-help-startedA designer claims design help and begins work. A reopened request fires this event again when it is reclaimed
design-help-endedA designer completes design help and submits the reviewed result

Cancelling or reopening a request does not fire design-help-ended. Repeating an already-started transition does not fire another event.

Both events identify the Design Help request in V2. V1 subscriptions receive data.projectId (and the existing data.id). V2 subscriptions receive resource.id and resource.href, pointing to /external/v2/projects/{projectId}/design-help/{designHelpId}.

Contract events

EventFires when
contract-sentA contract is sent for signature
contract-signedA contract is signed successfully. Includes contractUrl (expires in 24 hours): in data for both V1 and V2
contract-change-order-sentA change order is sent for a signed contract

Finance events

EventFires when
credit-application-submittedA credit application is submitted to a financier
application-decisionA finance application receives a decision from the financier (V1 only)

Energy audit events

EventFires when
energy-audit-updatedA project's energy audit (HVAC, electrical, attic, window/door, or lifestyle details) is updated
energy-audit-completedA project's energy audit transitions to complete (every section applicable to the organization has been filled in)

User events

EventFires when
user-createdA new user is created
user-updatedA user is updated
user-deletedA user is deleted

Users are an organization-level entity, so user events are dispatched to all installers within the organization that have subscribed to them.

Comment events

EventFires when
comment-createdA comment is created on a project
comment-updatedA comment is updated
comment-deletedA comment is soft-deleted

Building a reliable consumer

A robust webhook endpoint does four things: it verifies the signature, acknowledges fast, processes idempotently, and trusts timestamps over arrival order.

Acknowledge fast, then process

Verify the raw body signature, enqueue the event, and acknowledge with 2xx within milliseconds. Run database writes, API calls, and email in a background worker: the 30-second timeout triggers retries and duplicate deliveries.

Make handlers idempotent

Deliveries can repeat. Deduplicate V2 by the event id, not resource.id: many different events can refer to the same resource. For V1, there is no universal event ID in the envelope. Use event-specific identifiers and idempotent writes; event + data.id alone can suppress later legitimate changes.

Record success with the local data update, ideally in one transaction, never before processing. Calls to other services need their own idempotency strategy.

Read the latest state

V2's createdAt is the event timestamp, not the resource's current version. Neither version guarantees arrival order. For V1, relevant timestamps are part of the event data and vary by event.

Fetch V2 resource.href from your environment’s fixed Artemis API base URL with your attributed key; never send it to arbitrary hosts. Notifications signal a current-state read, not a full project, contract, or comment snapshot:

  • Project, contract, finance, energy-audit, and comment events identify the project. Use the relevant v2 project subresource when you need documents, financing, or comments.
  • Design-help events identify the individual request.
  • User events identify the user. After user-deleted, fetching it may return 404.

Retain the event ID for deduplication and make local reconciliation idempotent. If another worker is updating the same local resource, serialize or reconcile those writes so an older fetch cannot overwrite newer state.

Troubleshooting: "I'm not receiving events"

  1. Is the subscription active and subscribed to the event? Confirm the webhook is toggled Active and that the specific event type is in its event list. Use Test Webhook to send a sample for the selected events.
  2. Check the delivery logs. Delivery logs in Installer Settings → Developer show the response status and a truncated body for every attempt. A failed log with a 4xx means your endpoint rejected the request, often a signature mismatch (401) or a path/method that returns 404/405. Artemis does not retry 4xx.
  3. Is your endpoint reachable and fast? The callback URL must be public HTTPS and respond within 30 seconds. pending that flips to failed after retries usually means timeouts or 5xxs, check your service health and acknowledge before doing heavy work.
  4. Signature failing? Verify against the raw body, use the correct secret for this environment. V1 HMAC uses X-Signature; V2 uses X-Artemis-Webhook-Signature with X-Artemis-Webhook-Timestamp. Do not use the V1 signature formula for a V2 subscription.

V1 authentication & signing

These instructions apply to existing V1 subscriptions. V1 payloads contain event and a full data object. Supported HTTP methods are POST (default), GET, PUT, and DELETE.

Pick one auth type per subscription; Artemis adds the corresponding header to each delivery.

Auth typeHeader sentValue
hmacX-SignatureHMAC-SHA256(secret, body) as a hex digest
bearerAuthorizationBearer <token>
basicAuthorizationBasic <base64(username:password)>
apiKeyconfigurable, defaults to X-API-Keyyour configured key
none—no authentication header

Use HMAC whenever you can. It cryptographically proves both that the request came from Artemis and that the body wasn't tampered with in transit, without sharing a reusable bearer token.

For hmac subscriptions, Artemis computes the X-Signature header as HMAC-SHA256(secret, body) over the exact request body and hex-encodes it. To verify a delivery, recompute the same digest with your shared secret over the raw received body (before any middleware re-serializes the JSON) and compare it to the X-Signature header using a constant-time comparison.

This Node.js example verifies V1 HMAC deliveries using a raw-body Buffer:

import { createHmac, timingSafeEqual } from 'node:crypto'

function verifyV1Signature(rawBody, signature, secret) {
  if (!/^[a-f0-9]{64}$/.test(signature ?? '')) return false
  const expected = createHmac('sha256', secret).update(rawBody).digest()
  return timingSafeEqual(expected, Buffer.from(signature, 'hex'))
}

Pass the X-Signature header. V1 HMAC has no signed timestamp, so this check does not provide V2's replay-window check. Processing must still be idempotent.

Bearer token refresh

For bearer auth, if your endpoint responds 401 Unauthorized, Artemis attempts a token refresh and retries the delivery once with the new token (supported for OAuth providers configured on the subscription).

Event payload examples

Each event shows its V2 resource notification first. Expand the V1 example to consult the full event data used by an existing subscription. IDs are illustrative. Test deliveries verify transport and signing but their sample resources may not exist; use a real sandbox event to test resource reads.

project-created

Triggered after a project is created.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "project-created",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered after a project is created. Full project model including homeowner, system design, pricing, equipment breakdown, and roofing details.

{
  "event": "project-created",
  "data": {
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "proposalStatus": "Proposal Created",
    "proposalType": "Solar + Battery",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://app.example.com/customers/123e4567-e89b-12d3-a456-426614174000",
    "proposalUrl": "https://app.example.com/p/b52b31dc-abef-4f9d-8608-c197127b723b",
    "energyPlanUrl": "https://app.example.com/e/b52b31dc-abef-4f9d-8608-c197127b723b",
    "systemSize": 7.2,
    "homeowner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "address": "123 Main St",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "90210",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "team": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Installation Team Alpha",
      "type": "internal"
    },
    "installer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "best-installers-llc",
      "name": "Best Installers LLC",
      "website": "https://www.artemis.solar",
      "brandColor": "#5BB59F",
      "address": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "94101",
      "companyEmail": "hello@example.com",
      "companyPhone": "415-555-0123",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "assignedSalesRep": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94101",
      "countryCode": "US",
      "latitude": 37.6508961,
      "longitude": -121.8763871
    },
    "documents": [
      {
        "name": "utility_bill_march_2024.pdf",
        "documentType": "UTILITY_BILL",
        "mimeType": "application/pdf",
        "downloadUrl": "https://files.example.com/utility-bills/example.pdf",
        "url": "https://files.example.com/utility-bills/example.pdf",
        "uploadedAt": "2025-01-15T10:00:00.000Z"
      }
    ],
    "utilityBillAnalysis": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fileName": "utility_bill_march_2024.pdf",
      "fileUrl": "https://files.example.com/utility-bills/example.pdf",
      "annualKwh": 9600,
      "monthlyKwh": {
        "january": 750,
        "february": 680,
        "march": 710,
        "april": 720,
        "may": 820,
        "june": 950,
        "july": 1100,
        "august": 1100,
        "september": 880,
        "october": 790,
        "november": 710,
        "december": 790
      },
      "confidenceScore": 92,
      "analyzedAt": "2025-01-15T10:00:00.000Z",
      "dataSource": "AI_EXTRACTED"
    },
    "electricBill": 300,
    "paymentOption": "financed",
    "paymentMethod": "ach",
    "rgbBasemapUrl": "https://files.example.com/projects/example-project/rgb-rendered.jpeg",
    "rgbBasemapWithPanelsUrl": "https://files.example.com/projects/example-project/panels-preview.jpg",
    "rgbImageSize": 1024,
    "utilityDataSource": "sunrun",
    "utilityCompany": "Pacific Gas & Electric Co",
    "preSolarUtilityRate": 0.45,
    "postSolarUtilityRate": 0.45,
    "masterTariffId": "3289575",
    "preSolarTariffCode": "E-TOU-C-NEM2",
    "postSolarTariffCode": "E-TOU-C-NEM2",
    "preSolarEstimatedAnnualConsumptionAckwh": 8034.07,
    "postSolarEstimatedAnnualConsumptionAckwh": 8037.27,
    "estimatedAnnualProductionAckwh": 8597.78,
    "offset": 1.07,
    "basePPW": 2.91,
    "totalPPWBeforeIncentives": 7.77,
    "totalPPWAfterIncentives": 5.44,
    "addersTotalPrice": 2930,
    "baseSystemPrice": 34968.9,
    "loanAmount": 55941.29,
    "finalSystemPrice": 39158.9,
    "incentivesTotal": 16782.39,
    "initialLoanPayment": 212.73,
    "loanPayment": 212.73,
    "loanPaymentWithoutIncentives": 304.53,
    "energyConsumption": [
      613.803,
      545.513,
      572.829,
      586.487,
      654.777,
      750.382,
      886.961,
      886.961,
      709.408,
      641.119,
      572.829,
      613.803
    ],
    "energyPayment": [
      276.211,
      245.481,
      257.773,
      263.919,
      294.65,
      337.672,
      399.132,
      399.132,
      319.234,
      288.504,
      257.773,
      276.211
    ],
    "isStarred": true,
    "financier": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "financierType": "goodleap",
      "productType": "finance",
      "withACHDiscount": true,
      "financingProductId": "123e4567-e89b-12d3-a456-426614174000",
      "applicationStatus": null,
      "signedAt": "2026-01-21T13:37:06.359Z",
      "approvedAt": "2026-01-21T13:37:06.359Z",
      "name": "Standard installment",
      "term": 25,
      "reAmortizationPeriod": 18,
      "rate": 3.99,
      "escalatorRate": 3.99,
      "dealerFee": 0.3749,
      "minLoanAmount": 10000,
      "maxLoanAmount": 135000,
      "prePaymentPercentage": 30,
      "downPayment": 30,
      "paymentMethod": null
    },
    "solarPanel": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Longi 400w",
      "modelNumber": "LR5-54HABB-400M 400W",
      "manufacturerName": "Longi Solar",
      "capacityWatt": 400,
      "adder": 4.23,
      "units": "dollar_per_watt"
    },
    "inverter": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "SolarEdge Inverter",
      "manufacturerName": "SolarEdge Technologies",
      "modelNumber": "USE7600H-USMNBL75",
      "maxPowerOutputDCWatt": 7600,
      "adder": 0,
      "units": "dollar_per_watt"
    },
    "hasBattery": true,
    "battery": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "SolarEdge Home Battery (Domestic)",
      "modelNumber": "BAT-10K1P",
      "manufacturerName": "SolarEdge Technologies",
      "nominalCapacityPerBatteryKwh": 9.7,
      "adder": 8889,
      "units": "dollar"
    },
    "batteryMode": "backup",
    "batteryCount": 1,
    "activePanelsCount": 18,
    "inverterCount": 18,
    "systemDesignType": "ASD v2 - full",
    "upgrades": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Attic Run",
        "powerPrice": "$850.00",
        "unit": "dollar",
        "pricePerUnit": 850,
        "type": "fixed",
        "quantity": 1,
        "adder": 850,
        "isSelected": true,
        "goodleapUpgradeName": "ELECTRICAL"
      }
    ],
    "equipments": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "equipmentName": "Double Hung Window",
        "modelNumber": "DH-3000",
        "equipmentId": "123e4567-e89b-12d3-a456-426614174000",
        "equipmentType": "home-improvement",
        "homeImprovementType": "window",
        "quantity": 1,
        "attributes": [
          {
            "option_group_id": "123e4567-e89b-12d3-a456-426614174000",
            "option_group_name": "Room",
            "option_id": "123e4567-e89b-12d3-a456-426614174000",
            "option_name": "Bedroom"
          }
        ],
        "adders": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Low-E Glass Upgrade",
            "powerPrice": "$150.00",
            "pricePerUnit": 150,
            "type": "fixed",
            "unit": "dollar",
            "quantity": 1,
            "adder": 1,
            "isSelected": true,
            "labor": 50
          }
        ]
      }
    ],
    "georefImageParams": {
      "top_left_east": 599097.7328853768,
      "top_left_north": 4167696.175244914,
      "east_scale": 0.03901748020679803,
      "north_scale": 0.03901748020679803,
      "crs_utm": "EPSG:32610"
    },
    "solarPanels": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "panelCapacityWatts": 1711.2788565183728,
        "panelAnnualProdDckwh": 624.6167826292061,
        "segmentIndex": 1,
        "centerLat": 1,
        "centerLng": 1,
        "centerEast": 1,
        "centerNorth": 1,
        "solarArray": null,
        "pitch": 17.439,
        "azimuth": 110.726,
        "orientation": "LANDSCAPE",
        "pixC0": [
          531,
          292
        ],
        "pixC1": [
          511,
          308
        ],
        "pixC2": [
          536,
          317
        ],
        "pixC3": [
          551,
          278
        ],
        "pixC4": [
          526,
          268
        ],
        "order": 0,
        "projectId": "123e4567-e89b-12d3-a456-426614174000",
        "organizationId": "123e4567-e89b-12d3-a456-426614174000",
        "roofPlaneId": "123e4567-e89b-12d3-a456-426614174000",
        "color": "rgb(191,165,45)",
        "createdAt": "2026-01-21T13:37:06.359Z",
        "updatedAt": "2026-01-21T13:37:06.359Z"
      }
    ],
    "obstaclesWkt": [
      "POLYGON((599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914))",
      "POLYGON((599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914))"
    ],
    "arrayStats": {
      "1": {
        "orientation": "landscape",
        "tilt": 17.439,
        "azimuth": 110.726,
        "solarAccessValue": 0.9,
        "monthlySolarAccessValue": [
          0.85
        ],
        "tiltOrientationFactor": 0.8662,
        "totalSolarResourceFraction": 0.7796
      },
      "2": {
        "orientation": "portrait",
        "tilt": 17.439,
        "azimuth": 110.726,
        "solarAccessValue": 0.9,
        "monthlySolarAccessValue": [
          0.85
        ],
        "tiltOrientationFactor": 0.8662,
        "totalSolarResourceFraction": 0.7796
      }
    },
    "annualDegradationFactor": 0.005,
    "totalTermDegradationFactor": 0.12,
    "totalSolarResourceFraction": 0.7495,
    "estimatedYearsOfPowerProduction": 25,
    "preferredLanguage": "en",
    "externalProjectId": "EXTERNAL_PROJECT_ID",
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "summer_sale",
    "utmTerm": "solar",
    "utmContent": "ad_variant_1",
    "organizationId": "f754ac63-610d-42ff-82fb-67aa98892afd",
    "createdAt": "2024-05-22T18:55:50.289Z",
    "updatedAt": "2025-04-23T21:44:01.800Z",
    "baseSolarSystemTotalPrice": 34968.9,
    "baseBatteryPrice": 12000,
    "baseLoadManagementPrice": 2500,
    "baseHomeImprovementPrice": 5000,
    "baseHomeImprovementAddersPrice": 1500,
    "baseHvacAddersPrice": 850,
    "baseRoofAddersPrice": 1200,
    "additionalMargin": 15.5,
    "homeImprovementTypes": [
      "hvac",
      "window",
      "roof"
    ],
    "equipmentBreakdown": {
      "solar": {
        "panel": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Longi 400w",
          "manufacturer": "Longi Solar",
          "wattage": 400,
          "count": 18,
          "systemSizeKw": 7.2,
          "totalPrice": 1
        },
        "inverter": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "SolarEdge Inverter",
          "manufacturer": "SolarEdge Technologies",
          "count": 18,
          "totalPrice": 1
        },
        "totalPrice": 1
      },
      "battery": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "SolarEdge Home Battery (Domestic)",
        "manufacturer": "SolarEdge Technologies",
        "count": 1,
        "capacityPerUnitKwh": 9.7,
        "totalCapacityKwh": 9.7,
        "unitPrice": 1,
        "totalPrice": 1
      },
      "homeImprovement": {
        "items": [
          {
            "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
            "equipmentId": "b2c3d4e5-f6a7-8901-bc23-de45fg678901",
            "equipmentName": "Single Hung Window",
            "modelNumber": "SHW-2000",
            "displayName": "2x Single Hung Window (14\" W × 18\" H, BD1)",
            "type": "window",
            "quantity": 2,
            "unitPrice": 901.73,
            "totalEquipmentPrice": 1803.46,
            "adders": [
              {
                "id": "adder-1",
                "name": "ProSolar Shade Plus",
                "unitPrice": 16.99,
                "totalPrice": 33.98
              }
            ],
            "totalAddersPrice": 33.98,
            "totalPrice": 1837.44,
            "imageUrl": "https://files.example.com/equipment/window.png"
          },
          {
            "id": "c3d4e5f6-a7b8-9012-cd34-ef56gh789012",
            "equipmentId": "d4e5f6a7-b8c9-0123-de45-fg67hi890123",
            "equipmentName": "Central Air Conditioner 3 Ton",
            "modelNumber": "CAC-3T",
            "displayName": "Central Air Conditioner 3 Ton",
            "type": "hvac",
            "quantity": 1,
            "unitPrice": 6500,
            "totalEquipmentPrice": 6500,
            "adders": [
              {
                "id": "adder-2",
                "name": "Installation Fee",
                "unitPrice": 1500,
                "totalPrice": 1500
              }
            ],
            "totalAddersPrice": 1500,
            "totalPrice": 8000,
            "imageUrl": "https://files.example.com/equipment/hvac.png"
          }
        ],
        "totalByType": {
          "window": {
            "totalEquipmentPrice": 5000,
            "totalAddersPrice": 500,
            "totalPrice": 5500
          },
          "door": {
            "totalEquipmentPrice": 2500,
            "totalAddersPrice": 0,
            "totalPrice": 2500
          },
          "hvac": {
            "totalEquipmentPrice": 8000,
            "totalAddersPrice": 1500,
            "totalPrice": 9500
          },
          "insulation": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "water-heater": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "mpu": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "roof": {
            "totalEquipmentPrice": 12000,
            "totalAddersPrice": 0,
            "totalPrice": 12000
          }
        },
        "totalEquipmentPrice": 1,
        "totalAddersPrice": 1,
        "totalPrice": 1
      },
      "homeImprovementUpgrades": {
        "items": [
          {
            "id": "a1b2c3d4-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
            "name": "4th layer tear off - Per SQ",
            "type": "roof",
            "quantity": 3,
            "unitPrice": 74,
            "totalPrice": 222
          },
          {
            "id": "b2c3d4e5-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
            "name": "HVAC Duct Sealing",
            "type": "hvac",
            "quantity": 1,
            "unitPrice": 850,
            "totalPrice": 850
          }
        ],
        "totalByType": {
          "window": {
            "totalPrice": 0
          },
          "door": {
            "totalPrice": 0
          },
          "hvac": {
            "totalPrice": 850
          },
          "insulation": {
            "totalPrice": 0
          },
          "water-heater": {
            "totalPrice": 0
          },
          "mpu": {
            "totalPrice": 0
          },
          "roof": {
            "totalPrice": 222
          }
        },
        "totalPrice": 1072
      },
      "totalEquipmentPrice": 1
    },
    "tags": [],
    "customFieldValues": [
      {
        "customFieldId": "f4e3d2c1-b6a5-0987-fedc-ba0987654321",
        "value": "PO-12345",
        "createdAt": "2024-05-22T18:55:50.289Z",
        "updatedAt": "2024-05-22T18:55:50.289Z",
        "customField": {
          "name": "PO Number",
          "fieldType": "text"
        }
      },
      {
        "customFieldId": "a5b6c7d8-e9f0-1234-abcd-ef5678901234",
        "value": "true",
        "createdAt": "2024-05-22T18:55:50.289Z",
        "updatedAt": "2024-05-22T18:55:50.289Z",
        "customField": {
          "name": "Permit Approved",
          "fieldType": "checkbox"
        }
      }
    ],
    "statusHistories": [
      {
        "status": "Proposal Created",
        "statusUpdatedAt": "2024-05-22T18:55:50.289Z",
        "comment": null
      }
    ],
    "roofing": {
      "totalAreaSqft": 1230.7,
      "totalSquares": 12.31,
      "totalFacets": 2,
      "perimeterFt": 152.9,
      "predominantPitch": "4/12",
      "predominantPitchAreaSqft": 820.5,
      "pitchBreakdown": [
        {
          "pitch": "4/12",
          "areaSqft": 820.5,
          "areaSquares": 8.21,
          "percentageOfTotal": 66.67
        },
        {
          "pitch": "6/12",
          "areaSqft": 410.2,
          "areaSquares": 4.1,
          "percentageOfTotal": 33.33
        }
      ],
      "areaBreakdown": {
        "pitchedSqft": 1230.7,
        "flatSqft": 0,
        "unspecifiedPitchSqft": 0
      },
      "edges": {
        "ridgeFt": 42.1,
        "valleyFt": 18.3,
        "hipFt": 0,
        "rakeFt": 64.7,
        "eaveFt": 88.2,
        "parapetWallFt": 0,
        "stepFlashingFt": 0,
        "wallFlashingFt": 0,
        "apronFlashingFt": 0,
        "transitionFt": 0,
        "unassignedFt": 0
      },
      "wasteFactor": {
        "recommendedPercent": 15,
        "entries": [
          {
            "wastePercent": 0,
            "areaSqft": 1230.7,
            "areaSquares": 12.31
          },
          {
            "wastePercent": 10,
            "areaSqft": 1353.77,
            "areaSquares": 13.54
          },
          {
            "wastePercent": 12,
            "areaSqft": 1378.38,
            "areaSquares": 13.78
          },
          {
            "wastePercent": 15,
            "areaSqft": 1415.31,
            "areaSquares": 14.15
          },
          {
            "wastePercent": 17,
            "areaSqft": 1439.92,
            "areaSquares": 14.4
          },
          {
            "wastePercent": 20,
            "areaSqft": 1476.84,
            "areaSquares": 14.77
          },
          {
            "wastePercent": 22,
            "areaSqft": 1501.45,
            "areaSquares": 15.01
          }
        ]
      },
      "facets": [
        {
          "id": "b3a1f9c8-1b2c-4d5e-9a8f-1234567890ab",
          "letter": "A",
          "pitchDegrees": 18.43,
          "pitchRiseRun": "4/12",
          "azimuthDegrees": 180,
          "areaSqft": 820.5,
          "areaSquares": 8.21,
          "edges": [
            {
              "edgeIndex": 0,
              "edgeClass": "eave",
              "lengthFt": 44.1
            },
            {
              "edgeIndex": 1,
              "edgeClass": "rake",
              "lengthFt": 32.4
            },
            {
              "edgeIndex": 2,
              "edgeClass": "ridge",
              "lengthFt": 44.1
            },
            {
              "edgeIndex": 3,
              "edgeClass": "rake",
              "lengthFt": 32.4
            }
          ]
        },
        {
          "id": "b3a1f9c8-1b2c-4d5e-9a8f-cdef01234567",
          "letter": "B",
          "pitchDegrees": 26.57,
          "pitchRiseRun": "6/12",
          "azimuthDegrees": 0,
          "areaSqft": 410.2,
          "areaSquares": 4.1,
          "edges": []
        }
      ]
    }
  }
}

project-updated

Triggered after a project is updated.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "project-updated",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered after a project is updated. Same shape as project-created, with the current proposalStatus, statusHistories, and any updated fields (including tags).

{
  "event": "project-updated",
  "data": {
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "proposalStatus": "Credit Approved",
    "proposalType": "Solar + Battery",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://app.example.com/customers/123e4567-e89b-12d3-a456-426614174000",
    "proposalUrl": "https://app.example.com/p/b52b31dc-abef-4f9d-8608-c197127b723b",
    "energyPlanUrl": "https://app.example.com/e/b52b31dc-abef-4f9d-8608-c197127b723b",
    "systemSize": 7.2,
    "homeowner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "address": "123 Main St",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "90210",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "team": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Installation Team Alpha",
      "type": "internal"
    },
    "installer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "best-installers-llc",
      "name": "Best Installers LLC",
      "website": "https://www.artemis.solar",
      "brandColor": "#5BB59F",
      "address": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "94101",
      "companyEmail": "hello@example.com",
      "companyPhone": "415-555-0123",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "assignedSalesRep": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94101",
      "countryCode": "US",
      "latitude": 37.6508961,
      "longitude": -121.8763871
    },
    "documents": [
      {
        "name": "utility_bill_march_2024.pdf",
        "documentType": "UTILITY_BILL",
        "mimeType": "application/pdf",
        "downloadUrl": "https://files.example.com/utility-bills/example.pdf",
        "url": "https://files.example.com/utility-bills/example.pdf",
        "uploadedAt": "2025-01-15T10:00:00.000Z"
      }
    ],
    "utilityBillAnalysis": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fileName": "utility_bill_march_2024.pdf",
      "fileUrl": "https://files.example.com/utility-bills/example.pdf",
      "annualKwh": 9600,
      "monthlyKwh": {
        "january": 750,
        "february": 680,
        "march": 710,
        "april": 720,
        "may": 820,
        "june": 950,
        "july": 1100,
        "august": 1100,
        "september": 880,
        "october": 790,
        "november": 710,
        "december": 790
      },
      "confidenceScore": 92,
      "analyzedAt": "2025-01-15T10:00:00.000Z",
      "dataSource": "AI_EXTRACTED"
    },
    "electricBill": 300,
    "paymentOption": "financed",
    "paymentMethod": "ach",
    "rgbBasemapUrl": "https://files.example.com/projects/example-project/rgb-rendered.jpeg",
    "rgbBasemapWithPanelsUrl": "https://files.example.com/projects/example-project/panels-preview.jpg",
    "rgbImageSize": 1024,
    "utilityDataSource": "sunrun",
    "utilityCompany": "Pacific Gas & Electric Co",
    "preSolarUtilityRate": 0.45,
    "postSolarUtilityRate": 0.45,
    "masterTariffId": "3289575",
    "preSolarTariffCode": "E-TOU-C-NEM2",
    "postSolarTariffCode": "E-TOU-C-NEM2",
    "preSolarEstimatedAnnualConsumptionAckwh": 8034.07,
    "postSolarEstimatedAnnualConsumptionAckwh": 8037.27,
    "estimatedAnnualProductionAckwh": 8597.78,
    "offset": 1.07,
    "basePPW": 2.91,
    "totalPPWBeforeIncentives": 7.77,
    "totalPPWAfterIncentives": 5.44,
    "addersTotalPrice": 2930,
    "baseSystemPrice": 34968.9,
    "loanAmount": 55941.29,
    "finalSystemPrice": 39158.9,
    "incentivesTotal": 16782.39,
    "initialLoanPayment": 212.73,
    "loanPayment": 212.73,
    "loanPaymentWithoutIncentives": 304.53,
    "energyConsumption": [
      613.803,
      545.513,
      572.829,
      586.487,
      654.777,
      750.382,
      886.961,
      886.961,
      709.408,
      641.119,
      572.829,
      613.803
    ],
    "energyPayment": [
      276.211,
      245.481,
      257.773,
      263.919,
      294.65,
      337.672,
      399.132,
      399.132,
      319.234,
      288.504,
      257.773,
      276.211
    ],
    "isStarred": true,
    "financier": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "financierType": "goodleap",
      "productType": "finance",
      "withACHDiscount": true,
      "financingProductId": "123e4567-e89b-12d3-a456-426614174000",
      "applicationId": "123e4567-e89b-12d3-a456-426614174000",
      "offerId": "123e4567-e89b-12d3-a456-426614174000",
      "applicationStatus": "Approved",
      "signedAt": "2026-01-21T13:37:06.359Z",
      "approvedAt": "2026-01-21T13:37:06.359Z",
      "name": "Standard installment",
      "term": 25,
      "reAmortizationPeriod": 18,
      "rate": 3.99,
      "escalatorRate": 3.99,
      "dealerFee": 0.3749,
      "minLoanAmount": 10000,
      "maxLoanAmount": 135000,
      "prePaymentPercentage": 30,
      "downPayment": 30,
      "paymentMethod": null
    },
    "solarPanel": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Longi 400w",
      "modelNumber": "LR5-54HABB-400M 400W",
      "manufacturerName": "Longi Solar",
      "capacityWatt": 400,
      "adder": 4.23,
      "units": "dollar_per_watt"
    },
    "inverter": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "SolarEdge Inverter",
      "manufacturerName": "SolarEdge Technologies",
      "modelNumber": "USE7600H-USMNBL75",
      "maxPowerOutputDCWatt": 7600,
      "adder": 0,
      "units": "dollar_per_watt"
    },
    "hasBattery": true,
    "battery": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "SolarEdge Home Battery (Domestic)",
      "modelNumber": "BAT-10K1P",
      "manufacturerName": "SolarEdge Technologies",
      "nominalCapacityPerBatteryKwh": 9.7,
      "adder": 8889,
      "units": "dollar"
    },
    "batteryMode": "backup",
    "batteryCount": 1,
    "activePanelsCount": 18,
    "inverterCount": 18,
    "systemDesignType": "ASD v2 - full",
    "upgrades": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Attic Run",
        "powerPrice": "$850.00",
        "unit": "dollar",
        "pricePerUnit": 850,
        "type": "fixed",
        "quantity": 1,
        "adder": 850,
        "isSelected": true,
        "goodleapUpgradeName": "ELECTRICAL"
      }
    ],
    "equipments": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "equipmentName": "Double Hung Window",
        "modelNumber": "DH-3000",
        "equipmentId": "123e4567-e89b-12d3-a456-426614174000",
        "equipmentType": "home-improvement",
        "homeImprovementType": "window",
        "quantity": 1,
        "attributes": [
          {
            "option_group_id": "123e4567-e89b-12d3-a456-426614174000",
            "option_group_name": "Room",
            "option_id": "123e4567-e89b-12d3-a456-426614174000",
            "option_name": "Bedroom"
          }
        ],
        "adders": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Low-E Glass Upgrade",
            "powerPrice": "$150.00",
            "pricePerUnit": 150,
            "type": "fixed",
            "unit": "dollar",
            "quantity": 1,
            "adder": 1,
            "isSelected": true,
            "labor": 50
          }
        ]
      }
    ],
    "georefImageParams": {
      "top_left_east": 599097.7328853768,
      "top_left_north": 4167696.175244914,
      "east_scale": 0.03901748020679803,
      "north_scale": 0.03901748020679803,
      "crs_utm": "EPSG:32610"
    },
    "solarPanels": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "panelCapacityWatts": 1711.2788565183728,
        "panelAnnualProdDckwh": 624.6167826292061,
        "segmentIndex": 1,
        "centerLat": 1,
        "centerLng": 1,
        "centerEast": 1,
        "centerNorth": 1,
        "solarArray": null,
        "pitch": 17.439,
        "azimuth": 110.726,
        "orientation": "LANDSCAPE",
        "pixC0": [
          531,
          292
        ],
        "pixC1": [
          511,
          308
        ],
        "pixC2": [
          536,
          317
        ],
        "pixC3": [
          551,
          278
        ],
        "pixC4": [
          526,
          268
        ],
        "order": 0,
        "projectId": "123e4567-e89b-12d3-a456-426614174000",
        "organizationId": "123e4567-e89b-12d3-a456-426614174000",
        "roofPlaneId": "123e4567-e89b-12d3-a456-426614174000",
        "color": "rgb(191,165,45)",
        "createdAt": "2026-01-21T13:37:06.359Z",
        "updatedAt": "2026-01-21T13:37:06.359Z"
      }
    ],
    "obstaclesWkt": [
      "POLYGON((599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914))",
      "POLYGON((599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914))"
    ],
    "arrayStats": {
      "1": {
        "orientation": "landscape",
        "tilt": 17.439,
        "azimuth": 110.726,
        "solarAccessValue": 0.9,
        "monthlySolarAccessValue": [
          0.85
        ],
        "tiltOrientationFactor": 0.8662,
        "totalSolarResourceFraction": 0.7796
      },
      "2": {
        "orientation": "portrait",
        "tilt": 17.439,
        "azimuth": 110.726,
        "solarAccessValue": 0.9,
        "monthlySolarAccessValue": [
          0.85
        ],
        "tiltOrientationFactor": 0.8662,
        "totalSolarResourceFraction": 0.7796
      }
    },
    "annualDegradationFactor": 0.005,
    "totalTermDegradationFactor": 0.12,
    "totalSolarResourceFraction": 0.7495,
    "estimatedYearsOfPowerProduction": 25,
    "preferredLanguage": "en",
    "externalProjectId": "EXTERNAL_PROJECT_ID",
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "summer_sale",
    "utmTerm": "solar",
    "utmContent": "ad_variant_1",
    "organizationId": "f754ac63-610d-42ff-82fb-67aa98892afd",
    "createdAt": "2024-05-22T18:55:50.289Z",
    "updatedAt": "2025-04-23T21:44:01.800Z",
    "baseSolarSystemTotalPrice": 34968.9,
    "baseBatteryPrice": 12000,
    "baseLoadManagementPrice": 2500,
    "baseHomeImprovementPrice": 5000,
    "baseHomeImprovementAddersPrice": 1500,
    "baseHvacAddersPrice": 850,
    "baseRoofAddersPrice": 1200,
    "additionalMargin": 15.5,
    "homeImprovementTypes": [
      "hvac",
      "window",
      "roof"
    ],
    "equipmentBreakdown": {
      "solar": {
        "panel": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Longi 400w",
          "manufacturer": "Longi Solar",
          "wattage": 400,
          "count": 18,
          "systemSizeKw": 7.2,
          "totalPrice": 1
        },
        "inverter": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "SolarEdge Inverter",
          "manufacturer": "SolarEdge Technologies",
          "count": 18,
          "totalPrice": 1
        },
        "totalPrice": 1
      },
      "battery": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "SolarEdge Home Battery (Domestic)",
        "manufacturer": "SolarEdge Technologies",
        "count": 1,
        "capacityPerUnitKwh": 9.7,
        "totalCapacityKwh": 9.7,
        "unitPrice": 1,
        "totalPrice": 1
      },
      "homeImprovement": {
        "items": [
          {
            "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
            "equipmentId": "b2c3d4e5-f6a7-8901-bc23-de45fg678901",
            "equipmentName": "Single Hung Window",
            "modelNumber": "SHW-2000",
            "displayName": "2x Single Hung Window (14\" W × 18\" H, BD1)",
            "type": "window",
            "quantity": 2,
            "unitPrice": 901.73,
            "totalEquipmentPrice": 1803.46,
            "adders": [
              {
                "id": "adder-1",
                "name": "ProSolar Shade Plus",
                "unitPrice": 16.99,
                "totalPrice": 33.98
              }
            ],
            "totalAddersPrice": 33.98,
            "totalPrice": 1837.44,
            "imageUrl": "https://files.example.com/equipment/window.png"
          },
          {
            "id": "c3d4e5f6-a7b8-9012-cd34-ef56gh789012",
            "equipmentId": "d4e5f6a7-b8c9-0123-de45-fg67hi890123",
            "equipmentName": "Central Air Conditioner 3 Ton",
            "modelNumber": "CAC-3T",
            "displayName": "Central Air Conditioner 3 Ton",
            "type": "hvac",
            "quantity": 1,
            "unitPrice": 6500,
            "totalEquipmentPrice": 6500,
            "adders": [
              {
                "id": "adder-2",
                "name": "Installation Fee",
                "unitPrice": 1500,
                "totalPrice": 1500
              }
            ],
            "totalAddersPrice": 1500,
            "totalPrice": 8000,
            "imageUrl": "https://files.example.com/equipment/hvac.png"
          }
        ],
        "totalByType": {
          "window": {
            "totalEquipmentPrice": 5000,
            "totalAddersPrice": 500,
            "totalPrice": 5500
          },
          "door": {
            "totalEquipmentPrice": 2500,
            "totalAddersPrice": 0,
            "totalPrice": 2500
          },
          "hvac": {
            "totalEquipmentPrice": 8000,
            "totalAddersPrice": 1500,
            "totalPrice": 9500
          },
          "insulation": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "water-heater": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "mpu": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "roof": {
            "totalEquipmentPrice": 12000,
            "totalAddersPrice": 0,
            "totalPrice": 12000
          }
        },
        "totalEquipmentPrice": 1,
        "totalAddersPrice": 1,
        "totalPrice": 1
      },
      "homeImprovementUpgrades": {
        "items": [
          {
            "id": "a1b2c3d4-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
            "name": "4th layer tear off - Per SQ",
            "type": "roof",
            "quantity": 3,
            "unitPrice": 74,
            "totalPrice": 222
          },
          {
            "id": "b2c3d4e5-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
            "name": "HVAC Duct Sealing",
            "type": "hvac",
            "quantity": 1,
            "unitPrice": 850,
            "totalPrice": 850
          }
        ],
        "totalByType": {
          "window": {
            "totalPrice": 0
          },
          "door": {
            "totalPrice": 0
          },
          "hvac": {
            "totalPrice": 850
          },
          "insulation": {
            "totalPrice": 0
          },
          "water-heater": {
            "totalPrice": 0
          },
          "mpu": {
            "totalPrice": 0
          },
          "roof": {
            "totalPrice": 222
          }
        },
        "totalPrice": 1072
      },
      "totalEquipmentPrice": 1
    },
    "tags": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Priority",
        "color": "#ea580c",
        "tagDefinitionId": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
        "reason": "High priority customer"
      }
    ],
    "customFieldValues": [
      {
        "customFieldId": "f4e3d2c1-b6a5-0987-fedc-ba0987654321",
        "value": "PO-12345",
        "createdAt": "2024-05-22T18:55:50.289Z",
        "updatedAt": "2024-05-23T10:12:30.000Z",
        "customField": {
          "name": "PO Number",
          "fieldType": "text"
        }
      },
      {
        "customFieldId": "a5b6c7d8-e9f0-1234-abcd-ef5678901234",
        "value": "true",
        "createdAt": "2024-05-22T18:55:50.289Z",
        "updatedAt": "2024-05-23T10:12:30.000Z",
        "customField": {
          "name": "Permit Approved",
          "fieldType": "checkbox"
        }
      }
    ],
    "statusHistories": [
      {
        "status": "Proposal Created",
        "statusUpdatedAt": "2024-05-22T18:55:50.289Z",
        "comment": null
      },
      {
        "status": "Credit Submitted",
        "statusUpdatedAt": "2024-05-23T10:30:00.000Z",
        "comment": null
      },
      {
        "status": "Credit Approved",
        "statusUpdatedAt": "2024-05-25T14:20:00.000Z",
        "comment": null
      }
    ],
    "roofing": {
      "totalAreaSqft": 1230.7,
      "totalSquares": 12.31,
      "totalFacets": 2,
      "perimeterFt": 152.9,
      "predominantPitch": "4/12",
      "predominantPitchAreaSqft": 820.5,
      "pitchBreakdown": [
        {
          "pitch": "4/12",
          "areaSqft": 820.5,
          "areaSquares": 8.21,
          "percentageOfTotal": 66.67
        },
        {
          "pitch": "6/12",
          "areaSqft": 410.2,
          "areaSquares": 4.1,
          "percentageOfTotal": 33.33
        }
      ],
      "areaBreakdown": {
        "pitchedSqft": 1230.7,
        "flatSqft": 0,
        "unspecifiedPitchSqft": 0
      },
      "edges": {
        "ridgeFt": 42.1,
        "valleyFt": 18.3,
        "hipFt": 0,
        "rakeFt": 64.7,
        "eaveFt": 88.2,
        "parapetWallFt": 0,
        "stepFlashingFt": 0,
        "wallFlashingFt": 0,
        "apronFlashingFt": 0,
        "transitionFt": 0,
        "unassignedFt": 0
      },
      "wasteFactor": {
        "recommendedPercent": 15,
        "entries": [
          {
            "wastePercent": 0,
            "areaSqft": 1230.7,
            "areaSquares": 12.31
          },
          {
            "wastePercent": 10,
            "areaSqft": 1353.77,
            "areaSquares": 13.54
          },
          {
            "wastePercent": 12,
            "areaSqft": 1378.38,
            "areaSquares": 13.78
          },
          {
            "wastePercent": 15,
            "areaSqft": 1415.31,
            "areaSquares": 14.15
          },
          {
            "wastePercent": 17,
            "areaSqft": 1439.92,
            "areaSquares": 14.4
          },
          {
            "wastePercent": 20,
            "areaSqft": 1476.84,
            "areaSquares": 14.77
          },
          {
            "wastePercent": 22,
            "areaSqft": 1501.45,
            "areaSquares": 15.01
          }
        ]
      },
      "facets": [
        {
          "id": "b3a1f9c8-1b2c-4d5e-9a8f-1234567890ab",
          "letter": "A",
          "pitchDegrees": 18.43,
          "pitchRiseRun": "4/12",
          "azimuthDegrees": 180,
          "areaSqft": 820.5,
          "areaSquares": 8.21,
          "edges": [
            {
              "edgeIndex": 0,
              "edgeClass": "eave",
              "lengthFt": 44.1
            },
            {
              "edgeIndex": 1,
              "edgeClass": "rake",
              "lengthFt": 32.4
            },
            {
              "edgeIndex": 2,
              "edgeClass": "ridge",
              "lengthFt": 44.1
            },
            {
              "edgeIndex": 3,
              "edgeClass": "rake",
              "lengthFt": 32.4
            }
          ]
        },
        {
          "id": "b3a1f9c8-1b2c-4d5e-9a8f-cdef01234567",
          "letter": "B",
          "pitchDegrees": 26.57,
          "pitchRiseRun": "6/12",
          "azimuthDegrees": 0,
          "areaSqft": 410.2,
          "areaSquares": 4.1,
          "edges": []
        }
      ]
    }
  }
}

design-help-started

Triggered when a designer claims design help and begins work.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "design-help-started",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "design-help",
    "id": "01900000-0000-4000-8000-000000000001",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b/design-help/01900000-0000-4000-8000-000000000001"
  }
}
V1 example payload

Triggered when a designer claims design help and begins work. data.projectId identifies the project; data.id also contains the project ID. If the work is reopened and later reclaimed, Artemis sends a new design-help-started event.

{
  "event": "design-help-started",
  "data": {
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "projectId": "b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}

design-help-ended

Triggered when the designer completes design help and submits the reviewed result.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "design-help-ended",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "design-help",
    "id": "01900000-0000-4000-8000-000000000001",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b/design-help/01900000-0000-4000-8000-000000000001"
  }
}
V1 example payload

Triggered when the designer completes design help and submits the reviewed result. data.projectId identifies the project; data.id also contains the project ID. Cancelling or reopening the work does not send this event.

{
  "event": "design-help-ended",
  "data": {
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "projectId": "b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}

proposal-sent

Triggered when a proposal is emailed to a customer.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "proposal-sent",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when a proposal is emailed to a customer. The data object includes a proposalSentTo field, the address the proposal was sent to.

{
  "event": "proposal-sent",
  "data": {
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "proposalStatus": "Proposal Created",
    "proposalStatusUpdatedAt": "2026-01-21T13:37:06.359Z",
    "proposalType": "Solar + Battery",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://app.example.com/projects/b52b31dc-abef-4f9d-8608-c197127b723b",
    "proposalUrl": "https://app.example.com/p/b52b31dc-abef-4f9d-8608-c197127b723b",
    "energyPlanUrl": "https://app.example.com/e/b52b31dc-abef-4f9d-8608-c197127b723b",
    "systemSize": 7.2,
    "homeowner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "address": "123 Main St",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "90210",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "team": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Installation Team Alpha",
      "type": "internal"
    },
    "installer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "best-installers-llc",
      "name": "Best Installers LLC",
      "website": "https://www.artemis.solar",
      "brandColor": "#5BB59F",
      "address": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "94101",
      "companyEmail": "hello@example.com",
      "companyPhone": "415-555-0123",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "assignedSalesRep": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94101",
      "countryCode": "US",
      "latitude": 37.6508961,
      "longitude": -121.8763871
    },
    "paymentOption": "financed",
    "paymentMethod": "ach",
    "electricBill": 300,
    "utilityCompany": "Pacific Gas and Electric",
    "estimatedAnnualProductionAckwh": 9800,
    "offset": 1.02,
    "basePPW": 3,
    "totalPPWBeforeIncentives": 3.2,
    "totalPPWAfterIncentives": 2.45,
    "baseSystemPrice": 21600,
    "finalSystemPrice": 17640,
    "incentivesTotal": 3960,
    "proposalSentTo": "hello@example.com"
  }
}

pre-sale-status-updated

Triggered when the proposal status changes during the pre-sale phase.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "pre-sale-status-updated",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when the proposal status changes during the pre-sale phase. Includes the new proposalStatus, proposalStatusUpdatedAt, and the current project snapshot.

{
  "event": "pre-sale-status-updated",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "proposalStatus": "SITE_SURVEY_COMPLETED",
    "proposalStatusUpdatedAt": "2023-11-05T16:20:00.000Z",
    "proposalType": "Solar",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://client.example.com/customers/h1o2m3e4-o5w6-n7e8-r9i-d0abcdef12345",
    "proposalUrl": "https://client.example.com/p/a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "systemSize": 7.5,
    "homeowner": {
      "id": "h1o2m3e4-o5w6-n7e8-r9i-d0abcdef12345",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "555-123-4567"
    },
    "team": {
      "id": "t1e2a3m4-i5d6-7890-1234-567890abcdef",
      "name": "Installation Team Alpha"
    },
    "installer": {
      "id": "i1n2s3t4-a5l6-7890-1234-567890abcdef",
      "name": "Best Installers LLC"
    },
    "assignedSalesRep": {
      "id": "s1a2l3e4-s5r6-7890-1234-567890abcdef",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "phoneNumber": "555-987-6543",
      "createdAt": "2023-01-15T08:00:00.000Z",
      "updatedAt": "2023-10-20T14:20:00.000Z"
    },
    "address": {
      "street": "123 Sunny Lane",
      "city": "Sunshine City",
      "state": "CA",
      "zipcode": "90210",
      "countryCode": "US",
      "latitude": 34.0901,
      "longitude": -118.4065
    },
    "electricBill": 250.5,
    "paymentOption": "cash",
    "utilityDataSource": "UB_SCRAPER_API",
    "utilityCompany": "Southern California Edison",
    "preSolarUtilityRate": 0.32,
    "postSolarUtilityRate": 0.32,
    "masterTariffId": 12345,
    "preSolarTariffCode": "TOU-D-4-9PM",
    "postSolarTariffCode": "TOU-D-4-9PM",
    "preSolarEstimatedAnnualConsumptionAckwh": 12000,
    "postSolarEstimatedAnnualConsumptionAckwh": 12000,
    "estimatedAnnualProductionAckwh": 11500,
    "offset": 0.96,
    "basePPW": 3,
    "totalPPWBeforeIncentives": 3.2,
    "totalPPWAfterIncentives": 2.24,
    "addersTotalPrice": 1500,
    "baseSystemPrice": 22500,
    "loanAmount": 24000,
    "finalSystemPrice": 16800,
    "incentivesTotal": 7200,
    "initialLoanPayment": null,
    "loanPayment": null,
    "loanPaymentWithoutIncentives": null,
    "energyConsumption": [
      1000,
      900,
      950,
      1050,
      1100,
      1200,
      1300,
      1250,
      1150,
      1000,
      950,
      1150
    ],
    "energyPayment": [
      250,
      225,
      237.5,
      262.5,
      275,
      300,
      325,
      312.5,
      287.5,
      250,
      237.5,
      287.5
    ],
    "financier": null,
    "solarPanel": {
      "id": "sp1",
      "name": "Premium Panel 400W",
      "modelNumber": "PP-400-BLK",
      "manufacturerName": "SunPower",
      "capacityWatt": 400,
      "adder": 0,
      "units": "Watts"
    },
    "activePanelsCount": 19,
    "inverter": {
      "id": "inv1",
      "name": "Microinverter IQ8+",
      "modelNumber": "IQ8PLUS-72-2-US",
      "manufacturerName": "Enphase",
      "maxPowerOutputDCWatt": 300,
      "adder": 0,
      "units": "Watts"
    },
    "inverterCount": 19,
    "hasBattery": false,
    "battery": null,
    "batteryMode": null,
    "batteryCount": 0,
    "equipments": [],
    "systemDesignType": "auto",
    "upgrades": [
      {
        "name": "Main Panel Upgrade",
        "type": "electrical",
        "price": 1500,
        "quantity": 1
      }
    ],
    "preferredLanguage": "en",
    "isStarred": false,
    "createdAt": "2023-10-27T10:30:00.000Z",
    "updatedAt": "2023-11-05T16:20:00.000Z"
  }
}

post-sale-status-updated

Triggered when the proposal status changes during the post-sale phase (permitting, installation, completion).

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "post-sale-status-updated",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when the proposal status changes during the post-sale phase (permitting, installation, completion). Includes statusHistories with the full audit trail of post-sale transitions.

{
  "event": "post-sale-status-updated",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "proposalStatus": "INSTALLATION_COMPLETED",
    "proposalStatusUpdatedAt": "2023-12-10T13:00:00.000Z",
    "proposalType": "Solar",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://client.example.com/customers/h1o2m3e4-o5w6-n7e8-r9i-d0abcdef12345",
    "proposalUrl": "https://client.example.com/p/a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "systemSize": 7.5,
    "homeowner": {
      "id": "h1o2m3e4-o5w6-n7e8-r9i-d0abcdef12345",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "555-123-4567"
    },
    "team": {
      "id": "t1e2a3m4-i5d6-7890-1234-567890abcdef",
      "name": "Installation Team Alpha"
    },
    "installer": {
      "id": "i1n2s3t4-a5l6-7890-1234-567890abcdef",
      "name": "Best Installers LLC"
    },
    "assignedSalesRep": {
      "id": "s1a2l3e4-s5r6-7890-1234-567890abcdef",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "phoneNumber": "555-987-6543",
      "createdAt": "2023-01-15T08:00:00.000Z",
      "updatedAt": "2023-10-20T14:20:00.000Z"
    },
    "address": {
      "street": "123 Sunny Lane",
      "city": "Sunshine City",
      "state": "CA",
      "zipcode": "90210",
      "countryCode": "US",
      "latitude": 34.0901,
      "longitude": -118.4065
    },
    "electricBill": 250.5,
    "paymentOption": "cash",
    "utilityDataSource": "UB_SCRAPER_API",
    "utilityCompany": "Southern California Edison",
    "preSolarUtilityRate": 0.32,
    "postSolarUtilityRate": 0.32,
    "masterTariffId": 12345,
    "preSolarTariffCode": "TOU-D-4-9PM",
    "postSolarTariffCode": "TOU-D-4-9PM",
    "preSolarEstimatedAnnualConsumptionAckwh": 12000,
    "postSolarEstimatedAnnualConsumptionAckwh": 12000,
    "estimatedAnnualProductionAckwh": 11500,
    "offset": 0.96,
    "basePPW": 3,
    "totalPPWBeforeIncentives": 3.2,
    "totalPPWAfterIncentives": 2.24,
    "addersTotalPrice": 1500,
    "baseSystemPrice": 22500,
    "loanAmount": 24000,
    "finalSystemPrice": 16800,
    "incentivesTotal": 7200,
    "initialLoanPayment": null,
    "loanPayment": null,
    "loanPaymentWithoutIncentives": null,
    "energyConsumption": [
      1000,
      900,
      950,
      1050,
      1100,
      1200,
      1300,
      1250,
      1150,
      1000,
      950,
      1150
    ],
    "energyPayment": [
      250,
      225,
      237.5,
      262.5,
      275,
      300,
      325,
      312.5,
      287.5,
      250,
      237.5,
      287.5
    ],
    "financier": null,
    "solarPanel": {
      "id": "sp1",
      "name": "Premium Panel 400W",
      "modelNumber": "PP-400-BLK",
      "manufacturerName": "SunPower",
      "capacityWatt": 400,
      "adder": 0,
      "units": "Watts"
    },
    "activePanelsCount": 19,
    "inverter": {
      "id": "inv1",
      "name": "Microinverter IQ8+",
      "modelNumber": "IQ8PLUS-72-2-US",
      "manufacturerName": "Enphase",
      "maxPowerOutputDCWatt": 300,
      "adder": 0,
      "units": "Watts"
    },
    "inverterCount": 19,
    "hasBattery": false,
    "battery": null,
    "batteryMode": null,
    "batteryCount": 0,
    "equipments": [],
    "systemDesignType": "auto",
    "upgrades": [
      {
        "name": "Main Panel Upgrade",
        "type": "electrical",
        "price": 1500,
        "quantity": 1
      }
    ],
    "preferredLanguage": "en",
    "isStarred": false,
    "createdAt": "2023-10-27T10:30:00.000Z",
    "updatedAt": "2023-12-10T13:00:00.000Z",
    "statusHistories": [
      {
        "status": "Proposal Created",
        "statusUpdatedAt": "2023-10-27T10:30:00.000Z",
        "comment": null
      },
      {
        "status": "Permit Submitted",
        "statusUpdatedAt": "2023-11-15T10:00:00.000Z",
        "comment": null
      },
      {
        "status": "Permit Approved",
        "statusUpdatedAt": "2023-11-20T14:30:00.000Z",
        "comment": null
      },
      {
        "status": "Installation Completed",
        "statusUpdatedAt": "2023-12-10T13:00:00.000Z",
        "comment": null
      }
    ]
  }
}

contract-sent

Triggered when a contract is sent for signature. V2 identifies the project.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "contract-sent",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload
{
  "event": "contract-sent",
  "data": {
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "proposalStatus": "Contract Sent",
    "proposalStatusUpdatedAt": "2026-01-21T13:37:06.359Z",
    "proposalType": "Solar + Battery",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://app.example.com/projects/b52b31dc-abef-4f9d-8608-c197127b723b",
    "proposalUrl": "https://app.example.com/p/b52b31dc-abef-4f9d-8608-c197127b723b",
    "energyPlanUrl": "https://app.example.com/e/b52b31dc-abef-4f9d-8608-c197127b723b",
    "systemSize": 7.2,
    "homeowner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "address": "123 Main St",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "90210",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "team": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Installation Team Alpha",
      "type": "internal"
    },
    "installer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "best-installers-llc",
      "name": "Best Installers LLC",
      "website": "https://www.artemis.solar",
      "brandColor": "#5BB59F",
      "address": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "94101",
      "companyEmail": "hello@example.com",
      "companyPhone": "415-555-0123",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "assignedSalesRep": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94101",
      "countryCode": "US",
      "latitude": 37.6508961,
      "longitude": -121.8763871
    },
    "paymentOption": "financed",
    "paymentMethod": "ach",
    "contractUrl": "https://files.example.com/contracts/example-project/contract.pdf?signature=example",
    "electricBill": 300,
    "utilityCompany": "Pacific Gas and Electric",
    "estimatedAnnualProductionAckwh": 9800,
    "offset": 1.02,
    "basePPW": 3,
    "totalPPWBeforeIncentives": 3.2,
    "totalPPWAfterIncentives": 2.45,
    "baseSystemPrice": 21600,
    "finalSystemPrice": 17640,
    "incentivesTotal": 3960
  }
}

contract-signed

Triggered when a contract is signed successfully.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "contract-signed",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  },
  "data": {
    "contractUrl": "https://files.example.com/contracts/example-project/signed_contract.pdf?signature=example"
  }
}
V1 example payload

Triggered when a contract is signed successfully. The data object includes a contractUrl field, a signed URL to the executed contract PDF that expires in 24 hours.

{
  "event": "contract-signed",
  "data": {
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "proposalStatus": "Contract Signed",
    "proposalType": "Solar + Battery",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://app.example.com/customers/123e4567-e89b-12d3-a456-426614174000",
    "proposalUrl": "https://app.example.com/p/b52b31dc-abef-4f9d-8608-c197127b723b",
    "energyPlanUrl": "https://app.example.com/e/b52b31dc-abef-4f9d-8608-c197127b723b",
    "contractUrl": "https://files.example.com/contracts/example-project/signed_contract.pdf?signature=example",
    "systemSize": 7.2,
    "homeowner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "address": "123 Main St",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "90210",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "team": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Installation Team Alpha",
      "type": "internal"
    },
    "installer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "best-installers-llc",
      "name": "Best Installers LLC",
      "website": "https://www.artemis.solar",
      "brandColor": "#5BB59F",
      "address": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "countryCode": "US",
      "zipcode": "94101",
      "companyEmail": "hello@example.com",
      "companyPhone": "415-555-0123",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "assignedSalesRep": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "hello@example.com",
      "phoneNumber": "+1234567890",
      "createdAt": "2026-01-21T13:37:06.359Z",
      "updatedAt": "2026-01-21T13:37:06.359Z"
    },
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94101",
      "countryCode": "US",
      "latitude": 37.6508961,
      "longitude": -121.8763871
    },
    "documents": [
      {
        "name": "utility_bill_march_2024.pdf",
        "documentType": "UTILITY_BILL",
        "mimeType": "application/pdf",
        "downloadUrl": "https://files.example.com/utility-bills/example.pdf",
        "url": "https://files.example.com/utility-bills/example.pdf",
        "uploadedAt": "2025-01-15T10:00:00.000Z"
      }
    ],
    "electricBill": 300,
    "paymentOption": "financed",
    "paymentMethod": "ach",
    "rgbBasemapUrl": "https://files.example.com/projects/example-project/rgb-rendered.jpeg",
    "rgbBasemapWithPanelsUrl": "https://files.example.com/projects/example-project/panels-preview.jpg",
    "rgbImageSize": 1024,
    "utilityDataSource": "sunrun",
    "utilityCompany": "Pacific Gas & Electric Co",
    "preSolarUtilityRate": 0.45,
    "postSolarUtilityRate": 0.45,
    "masterTariffId": "3289575",
    "preSolarTariffCode": "E-TOU-C-NEM2",
    "postSolarTariffCode": "E-TOU-C-NEM2",
    "preSolarEstimatedAnnualConsumptionAckwh": 8034.07,
    "postSolarEstimatedAnnualConsumptionAckwh": 8037.27,
    "estimatedAnnualProductionAckwh": 8597.78,
    "offset": 1.07,
    "basePPW": 2.91,
    "totalPPWBeforeIncentives": 7.77,
    "totalPPWAfterIncentives": 5.44,
    "addersTotalPrice": 2930,
    "baseSystemPrice": 34968.9,
    "loanAmount": 55941.29,
    "finalSystemPrice": 39158.9,
    "incentivesTotal": 16782.39,
    "initialLoanPayment": 212.73,
    "loanPayment": 212.73,
    "loanPaymentWithoutIncentives": 304.53,
    "energyConsumption": [
      613.803,
      545.513,
      572.829,
      586.487,
      654.777,
      750.382,
      886.961,
      886.961,
      709.408,
      641.119,
      572.829,
      613.803
    ],
    "energyPayment": [
      276.211,
      245.481,
      257.773,
      263.919,
      294.65,
      337.672,
      399.132,
      399.132,
      319.234,
      288.504,
      257.773,
      276.211
    ],
    "isStarred": true,
    "financier": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "financierType": "goodleap",
      "productType": "finance",
      "withACHDiscount": true,
      "financingProductId": "123e4567-e89b-12d3-a456-426614174000",
      "applicationId": "123e4567-e89b-12d3-a456-426614174000",
      "offerId": "123e4567-e89b-12d3-a456-426614174000",
      "applicationStatus": "Approved",
      "signedAt": "2026-01-21T13:37:06.359Z",
      "approvedAt": "2026-01-21T13:37:06.359Z",
      "name": "Standard installment",
      "term": 25,
      "reAmortizationPeriod": 18,
      "rate": 3.99,
      "escalatorRate": 3.99,
      "dealerFee": 0.3749,
      "minLoanAmount": 10000,
      "maxLoanAmount": 135000,
      "prePaymentPercentage": 30,
      "downPayment": 30,
      "paymentMethod": null
    },
    "solarPanel": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Longi 400w",
      "modelNumber": "LR5-54HABB-400M 400W",
      "manufacturerName": "Longi Solar",
      "capacityWatt": 400,
      "adder": 4.23,
      "units": "dollar_per_watt"
    },
    "inverter": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "SolarEdge Inverter",
      "manufacturerName": "SolarEdge Technologies",
      "modelNumber": "USE7600H-USMNBL75",
      "maxPowerOutputDCWatt": 7600,
      "adder": 0,
      "units": "dollar_per_watt"
    },
    "hasBattery": true,
    "battery": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "SolarEdge Home Battery (Domestic)",
      "modelNumber": "BAT-10K1P",
      "manufacturerName": "SolarEdge Technologies",
      "nominalCapacityPerBatteryKwh": 9.7,
      "adder": 8889,
      "units": "dollar"
    },
    "batteryMode": "backup",
    "batteryCount": 1,
    "activePanelsCount": 18,
    "inverterCount": 18,
    "systemDesignType": "ASD v2 - full",
    "upgrades": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Attic Run",
        "powerPrice": "$850.00",
        "unit": "dollar",
        "pricePerUnit": 850,
        "type": "fixed",
        "quantity": 1,
        "adder": 850,
        "isSelected": true,
        "goodleapUpgradeName": "ELECTRICAL"
      }
    ],
    "equipments": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "equipmentName": "Double Hung Window",
        "equipmentId": "123e4567-e89b-12d3-a456-426614174000",
        "equipmentType": "home-improvement",
        "homeImprovementType": "window",
        "quantity": 1,
        "attributes": [
          {
            "option_group_id": "123e4567-e89b-12d3-a456-426614174000",
            "option_group_name": "Room",
            "option_id": "123e4567-e89b-12d3-a456-426614174000",
            "option_name": "Bedroom"
          }
        ],
        "adders": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Low-E Glass Upgrade",
            "powerPrice": "$150.00",
            "pricePerUnit": 150,
            "type": "fixed",
            "unit": "dollar",
            "quantity": 1,
            "adder": 1,
            "isSelected": true,
            "labor": 50
          }
        ]
      }
    ],
    "georefImageParams": {
      "top_left_east": 599097.7328853768,
      "top_left_north": 4167696.175244914,
      "east_scale": 0.03901748020679803,
      "north_scale": 0.03901748020679803,
      "crs_utm": "EPSG:32610"
    },
    "solarPanels": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "panelCapacityWatts": 1711.2788565183728,
        "panelAnnualProdDckwh": 624.6167826292061,
        "segmentIndex": 1,
        "centerLat": 1,
        "centerLng": 1,
        "centerEast": 1,
        "centerNorth": 1,
        "solarArray": null,
        "pitch": 17.439,
        "azimuth": 110.726,
        "orientation": "LANDSCAPE",
        "pixC0": [
          531,
          292
        ],
        "pixC1": [
          511,
          308
        ],
        "pixC2": [
          536,
          317
        ],
        "pixC3": [
          551,
          278
        ],
        "pixC4": [
          526,
          268
        ],
        "order": 0,
        "projectId": "123e4567-e89b-12d3-a456-426614174000",
        "organizationId": "123e4567-e89b-12d3-a456-426614174000",
        "roofPlaneId": "123e4567-e89b-12d3-a456-426614174000",
        "color": "rgb(191,165,45)",
        "createdAt": "2026-01-21T13:37:06.359Z",
        "updatedAt": "2026-01-21T13:37:06.359Z"
      }
    ],
    "obstaclesWkt": [
      "POLYGON((599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914))",
      "POLYGON((599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914, 599097.7328853768 4167696.175244914))"
    ],
    "arrayStats": {
      "1": {
        "orientation": "landscape",
        "tilt": 17.439,
        "azimuth": 110.726,
        "solarAccessValue": 0.9,
        "monthlySolarAccessValue": [
          0.85
        ],
        "tiltOrientationFactor": 0.8662,
        "totalSolarResourceFraction": 0.7796
      },
      "2": {
        "orientation": "portrait",
        "tilt": 17.439,
        "azimuth": 110.726,
        "solarAccessValue": 0.9,
        "monthlySolarAccessValue": [
          0.85
        ],
        "tiltOrientationFactor": 0.8662,
        "totalSolarResourceFraction": 0.7796
      }
    },
    "annualDegradationFactor": 0.005,
    "totalTermDegradationFactor": 0.12,
    "totalSolarResourceFraction": 0.7495,
    "estimatedYearsOfPowerProduction": 25,
    "preferredLanguage": "en",
    "externalProjectId": "EXTERNAL_PROJECT_ID",
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "summer_sale",
    "utmTerm": "solar",
    "utmContent": "ad_variant_1",
    "organizationId": "f754ac63-610d-42ff-82fb-67aa98892afd",
    "createdAt": "2024-05-22T18:55:50.289Z",
    "updatedAt": "2025-04-23T21:44:01.800Z",
    "baseSolarSystemTotalPrice": 34968.9,
    "baseBatteryPrice": 12000,
    "baseLoadManagementPrice": 2500,
    "baseHomeImprovementPrice": 5000,
    "baseHomeImprovementAddersPrice": 1500,
    "baseHvacAddersPrice": 850,
    "baseRoofAddersPrice": 1200,
    "additionalMargin": 15.5,
    "homeImprovementTypes": [
      "hvac",
      "window",
      "roof"
    ],
    "equipmentBreakdown": {
      "solar": {
        "panel": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Longi 400w",
          "manufacturer": "Longi Solar",
          "wattage": 400,
          "count": 18,
          "systemSizeKw": 7.2,
          "totalPrice": 1
        },
        "inverter": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "SolarEdge Inverter",
          "manufacturer": "SolarEdge Technologies",
          "count": 18,
          "totalPrice": 1
        },
        "totalPrice": 1
      },
      "battery": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "SolarEdge Home Battery (Domestic)",
        "manufacturer": "SolarEdge Technologies",
        "count": 1,
        "capacityPerUnitKwh": 9.7,
        "totalCapacityKwh": 9.7,
        "unitPrice": 1,
        "totalPrice": 1
      },
      "homeImprovement": {
        "items": [
          {
            "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
            "equipmentId": "b2c3d4e5-f6a7-8901-bc23-de45fg678901",
            "equipmentName": "Single Hung Window",
            "modelNumber": "SHW-2000",
            "displayName": "2x Single Hung Window (14\" W × 18\" H, BD1)",
            "type": "window",
            "quantity": 2,
            "unitPrice": 901.73,
            "totalEquipmentPrice": 1803.46,
            "adders": [
              {
                "id": "adder-1",
                "name": "ProSolar Shade Plus",
                "unitPrice": 16.99,
                "totalPrice": 33.98
              }
            ],
            "totalAddersPrice": 33.98,
            "totalPrice": 1837.44,
            "imageUrl": "https://files.example.com/equipment/window.png"
          },
          {
            "id": "c3d4e5f6-a7b8-9012-cd34-ef56gh789012",
            "equipmentId": "d4e5f6a7-b8c9-0123-de45-fg67hi890123",
            "equipmentName": "Central Air Conditioner 3 Ton",
            "modelNumber": "CAC-3T",
            "displayName": "Central Air Conditioner 3 Ton",
            "type": "hvac",
            "quantity": 1,
            "unitPrice": 6500,
            "totalEquipmentPrice": 6500,
            "adders": [
              {
                "id": "adder-2",
                "name": "Installation Fee",
                "unitPrice": 1500,
                "totalPrice": 1500
              }
            ],
            "totalAddersPrice": 1500,
            "totalPrice": 8000,
            "imageUrl": "https://files.example.com/equipment/hvac.png"
          }
        ],
        "totalByType": {
          "window": {
            "totalEquipmentPrice": 5000,
            "totalAddersPrice": 500,
            "totalPrice": 5500
          },
          "door": {
            "totalEquipmentPrice": 2500,
            "totalAddersPrice": 0,
            "totalPrice": 2500
          },
          "hvac": {
            "totalEquipmentPrice": 8000,
            "totalAddersPrice": 1500,
            "totalPrice": 9500
          },
          "insulation": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "water-heater": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "mpu": {
            "totalEquipmentPrice": 0,
            "totalAddersPrice": 0,
            "totalPrice": 0
          },
          "roof": {
            "totalEquipmentPrice": 12000,
            "totalAddersPrice": 0,
            "totalPrice": 12000
          }
        },
        "totalEquipmentPrice": 1,
        "totalAddersPrice": 1,
        "totalPrice": 1
      },
      "homeImprovementUpgrades": {
        "items": [
          {
            "id": "a1b2c3d4-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
            "name": "4th layer tear off - Per SQ",
            "type": "roof",
            "quantity": 3,
            "unitPrice": 74,
            "totalPrice": 222
          },
          {
            "id": "b2c3d4e5-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
            "name": "HVAC Duct Sealing",
            "type": "hvac",
            "quantity": 1,
            "unitPrice": 850,
            "totalPrice": 850
          }
        ],
        "totalByType": {
          "window": {
            "totalPrice": 0
          },
          "door": {
            "totalPrice": 0
          },
          "hvac": {
            "totalPrice": 850
          },
          "insulation": {
            "totalPrice": 0
          },
          "water-heater": {
            "totalPrice": 0
          },
          "mpu": {
            "totalPrice": 0
          },
          "roof": {
            "totalPrice": 222
          }
        },
        "totalPrice": 1072
      },
      "totalEquipmentPrice": 1
    },
    "statusHistories": [
      {
        "status": "Proposal Created",
        "statusUpdatedAt": "2024-05-22T18:55:50.289Z",
        "comment": null
      },
      {
        "status": "Credit Submitted",
        "statusUpdatedAt": "2024-05-23T10:30:00.000Z",
        "comment": null
      },
      {
        "status": "Credit Approved",
        "statusUpdatedAt": "2024-05-25T14:20:00.000Z",
        "comment": null
      },
      {
        "status": "Contract Sent",
        "statusUpdatedAt": "2024-05-26T10:30:00.000Z",
        "comment": null
      },
      {
        "status": "Contract Signed",
        "statusUpdatedAt": "2024-05-27T10:30:00.000Z",
        "comment": null
      }
    ]
  }
}

contract-change-order-sent

Triggered when a change order is sent for a signed contract.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "contract-change-order-sent",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when a change order is sent for a signed contract.

{
  "event": "contract-change-order-sent",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "proposalStatus": "CONTRACT_SIGNED",
    "proposalStatusUpdatedAt": "2023-11-01T09:15:00.000Z",
    "proposalType": "Solar",
    "companyName": "Solar Solutions Inc.",
    "customerUrl": "https://client.example.com/customers/h1o2m3e4-o5w6-n7e8-r9i-d0abcdef12345",
    "proposalUrl": "https://client.example.com/p/a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "contractUrl": "https://files.example.com/contracts/example-project/signed_contract.pdf?signature=example",
    "systemSize": 7.5,
    "homeowner": {
      "id": "h1o2m3e4-o5w6-n7e8-r9i-d0abcdef12345",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "555-123-4567"
    },
    "team": {
      "id": "t1e2a3m4-i5d6-7890-1234-567890abcdef",
      "name": "Installation Team Alpha"
    },
    "installer": {
      "id": "i1n2s3t4-a5l6-7890-1234-567890abcdef",
      "name": "Best Installers LLC"
    },
    "assignedSalesRep": {
      "id": "s1a2l3e4-s5r6-7890-1234-567890abcdef",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "phoneNumber": "555-987-6543",
      "createdAt": "2023-01-15T08:00:00.000Z",
      "updatedAt": "2023-10-20T14:20:00.000Z"
    },
    "address": {
      "street": "123 Sunny Lane",
      "city": "Sunshine City",
      "state": "CA",
      "zipcode": "90210",
      "countryCode": "US",
      "latitude": 34.0901,
      "longitude": -118.4065
    },
    "electricBill": 250.5,
    "paymentOption": "cash",
    "utilityDataSource": "UB_SCRAPER_API",
    "utilityCompany": "Southern California Edison",
    "preSolarUtilityRate": 0.32,
    "postSolarUtilityRate": 0.32,
    "masterTariffId": 12345,
    "preSolarTariffCode": "TOU-D-4-9PM",
    "postSolarTariffCode": "TOU-D-4-9PM",
    "preSolarEstimatedAnnualConsumptionAckwh": 12000,
    "postSolarEstimatedAnnualConsumptionAckwh": 12000,
    "estimatedAnnualProductionAckwh": 11500,
    "offset": 0.96,
    "basePPW": 3,
    "totalPPWBeforeIncentives": 3.2,
    "totalPPWAfterIncentives": 2.24,
    "addersTotalPrice": 1500,
    "baseSystemPrice": 22500,
    "loanAmount": 24000,
    "finalSystemPrice": 16800,
    "incentivesTotal": 7200,
    "initialLoanPayment": null,
    "loanPayment": null,
    "loanPaymentWithoutIncentives": null,
    "energyConsumption": [
      1000,
      900,
      950,
      1050,
      1100,
      1200,
      1300,
      1250,
      1150,
      1000,
      950,
      1150
    ],
    "energyPayment": [
      250,
      225,
      237.5,
      262.5,
      275,
      300,
      325,
      312.5,
      287.5,
      250,
      237.5,
      287.5
    ],
    "financier": null,
    "solarPanel": {
      "id": "sp1",
      "name": "Premium Panel 400W",
      "modelNumber": "PP-400-BLK",
      "manufacturerName": "SunPower",
      "capacityWatt": 400,
      "adder": 0,
      "units": "Watts"
    },
    "activePanelsCount": 19,
    "inverter": {
      "id": "inv1",
      "name": "Microinverter IQ8+",
      "modelNumber": "IQ8PLUS-72-2-US",
      "manufacturerName": "Enphase",
      "maxPowerOutputDCWatt": 300,
      "adder": 0,
      "units": "Watts"
    },
    "inverterCount": 19,
    "hasBattery": false,
    "battery": null,
    "batteryMode": null,
    "batteryCount": 0,
    "equipments": [],
    "systemDesignType": "auto",
    "upgrades": [
      {
        "name": "Main Panel Upgrade",
        "type": "electrical",
        "price": 1500,
        "quantity": 1
      }
    ],
    "preferredLanguage": "en",
    "isStarred": false,
    "createdAt": "2023-10-27T10:30:00.000Z",
    "updatedAt": "2023-11-01T09:15:00.000Z"
  }
}

credit-application-submitted

Triggered when a credit application is submitted to a financier.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "credit-application-submitted",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when a credit application is submitted to a financier. Includes the primary applicant, optional co-applicant, and property information.

{
  "event": "credit-application-submitted",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "organizationId": 123,
    "primaryApplicant": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "555-123-4567",
      "dateOfBirth": "1980-05-15",
      "ssn": "***-**-1234",
      "annualIncome": 85000,
      "employmentStatus": "Employed"
    },
    "coApplicant": true,
    "coApplicantInfo": {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@example.com",
      "phoneNumber": "555-987-6543",
      "dateOfBirth": "1982-08-20",
      "ssn": "***-**-5678",
      "annualIncome": 75000,
      "employmentStatus": "Employed"
    },
    "propertyInfo": {
      "street": "123 Sunny Lane",
      "city": "Sunshine City",
      "state": "CA",
      "zipcode": "90210",
      "housingStatus": "Own",
      "yearsAtAddress": 5
    }
  }
}

application-decision

V1 only. This event is not available for V2 subscriptions.

Triggered after a finance application receives a decision from the financier. The data object contains the application identifier, the decision status, and the financier details.

V1 example payload
{
  "event": "application-decision",
  "data": {
    "applicationId": "APP-123456789",
    "applicationStatus": "APPROVED",
    "financier": {
      "id": "f1i2n3a4-n5c6-7890-1234-567890abcdef",
      "financierType": "goodleap",
      "productType": "loan",
      "applicationId": "APP-123456789",
      "applicationStatus": "APPROVED",
      "approvedAt": "2023-11-02T11:00:00.000Z",
      "maxLoanAmount": 50000,
      "interestRate": 3.99,
      "termMonths": 240
    }
  }
}

energy-audit-updated

Triggered when a project's energy audit is updated.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "energy-audit-updated",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when a project's energy audit is updated. Covers HVAC, electrical, attic, window/door, and lifestyle details captured during the audit.

{
  "event": "energy-audit-updated",
  "data": {
    "id": "d3bd3568-88ad-4e75-b8d0-1a2219186eed",
    "projectId": "4bbbb26a-2ab2-4688-a7fb-46885d4ffdd9",
    "hvacDetails": {
      "heatingType": "electric",
      "upstairsUnit": {
        "age": "5",
        "model": "model-example",
        "seerType": "SEER2",
        "seerRating": "",
        "lastServiceDate": "6",
        "installationDate": "4",
        "linesetInsulation": "intact"
      },
      "homeYearBuilt": "1988",
      "downstairsUnit": {
        "age": "5",
        "model": "model-example",
        "seerType": "SEER2",
        "seerRating": "16.2",
        "lastServiceDate": "6",
        "installationDate": "4",
        "linesetInsulation": "intact"
      },
      "thermostatModel": "Honeywell",
      "homeSquareFootage": "152",
      "homeownerQuestions": {
        "recentHvacRepair": false,
        "systemRunsConstantly": true,
        "thermostatSetOnASchedule": true,
        "noticeUnevenRoomTemperatures": true,
        "systemStruggleInExtremeSeasons": false
      },
      "images": [
        "https://files.example.com/equipment/hvac-Product.jpeg",
        "https://files.example.com/equipment/hvac-Artemis_Solar_Logo.png"
      ]
    },
    "electricalDetails": {
      "panelAge": "4",
      "panelBrand": "brand-panel",
      "meterCondition": "intact",
      "homeownerQuestions": {
        "breakersTripOften": true,
        "lightsFlickerOrDim": true,
        "meterConditionNotes": "Comments",
        "recentHighPowerAdditions": true
      },
      "mainBreakerAmperage": "150",
      "overheatingOrCorrosionOrDoubleTapsSigns": false,
      "images": [
        "https://files.example.com/equipment/electrical-Artemis_Solar_Logo.png"
      ]
    },
    "atticDetails": {
      "ductsIntact": true,
      "airHandlerFurnace": [
        {
          "age": "6",
          "model": "model-1",
          "location": "basement"
        },
        {
          "age": "4",
          "model": "model-2",
          "location": "closet"
        },
        {
          "age": "2",
          "model": "model-3",
          "location": "garage"
        }
      ],
      "ductsVisibleLeaks": true,
      "homeownerQuestions": {
        "notes": "Notes",
        "rodentsAroundAttic": true,
        "lastInspectionOrAddedDate": "6",
        "hotColdRoomsOrFloorToFloorTemperatureSwings": true
      },
      "atticInsulationLevel": "adequate",
      "atticDraftsNearHatchPenetrations": true,
      "atticSignOfMoisturePestsOrRodents": false,
      "images": [
        "https://files.example.com/equipment/attic-Product.jpeg"
      ]
    },
    "windowDoorsDetails": {
      "windowType": "mixed",
      "draftsAtDoors": true,
      "draftsAtWindows": true,
      "difficultToOperate": true,
      "homeownerQuestions": {
        "notes": "Notes about windows and doors",
        "recentReplacements": true,
        "draftsInSpecificRooms": true,
        "recentReplacementsQuantity": 5,
        "recentReplacementsHowLongAgo": "6"
      },
      "draftsAtDoorsQuantity": 1,
      "draftsAtWindowsQuantity": 1,
      "doublePaneWindowQuantity": 3,
      "singlePaneWindowQuantity": 5,
      "crackedWarpedDamagedFrames": true,
      "difficultToOperateQuantity": 3,
      "condensationFoggingBetweenPanes": true,
      "crackedWarpedDamagedFramesQuantity": 2,
      "condensationFoggingBetweenPanesQuantity": 1,
      "images": [
        "https://files.example.com/equipment/window_doors-Product.jpeg"
      ]
    },
    "lifestyleDetails": {
      "waterHeaterAge": "5",
      "waterHeaterType": "tankless",
      "homeownerQuestions": {
        "notes": "Lifestyle notes",
        "longStayPlanning": true,
        "mostConsumptionEnergyPeriod": "day",
        "comfortSafetyCostConcernsComments": "Concerns notes",
        "electricBillsSpikeDueSeasonChange": true,
        "homeTypicallyOccupiedDuringTheDay": true,
        "solarRenewableOrBackupPowerInterest": true
      },
      "houseCurrentlyHasSolar": true,
      "solarSystemFinanceType": "lease-ppa",
      "houseCurrentlyHasBattery": "yes",
      "receivingTraditionalBills": "no",
      "majorInefficientOrOldAppliances": true,
      "images": [
        "https://files.example.com/equipment/lifestyle-Product.jpeg"
      ]
    },
    "status": "in_progress",
    "completedAt": null,
    "createdAt": "2026-01-07T16:20:27.594Z",
    "updatedAt": "2026-01-07T17:11:14.189Z"
  }
}

energy-audit-completed

Triggered when a project's energy audit transitions to complete: every section applicable to the organization (HVAC, electrical, attic, window/door, lifestyle) has data. Later edits do not trigger a new event while the audit stays complete. Deliveries may still repeat due to retries.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "energy-audit-completed",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload
{
  "event": "energy-audit-completed",
  "data": {
    "id": "d3bd3568-88ad-4e75-b8d0-1a2219186eed",
    "projectId": "4bbbb26a-2ab2-4688-a7fb-46885d4ffdd9",
    "hvacDetails": {
      "heatingType": "electric",
      "upstairsUnit": {
        "age": "5",
        "model": "model-example",
        "seerType": "SEER2",
        "seerRating": "",
        "lastServiceDate": "6",
        "installationDate": "4",
        "linesetInsulation": "intact"
      },
      "homeYearBuilt": "1988",
      "downstairsUnit": {
        "age": "5",
        "model": "model-example",
        "seerType": "SEER2",
        "seerRating": "16.2",
        "lastServiceDate": "6",
        "installationDate": "4",
        "linesetInsulation": "intact"
      },
      "thermostatModel": "Honeywell",
      "homeSquareFootage": "152",
      "homeownerQuestions": {
        "recentHvacRepair": false,
        "systemRunsConstantly": true,
        "thermostatSetOnASchedule": true,
        "noticeUnevenRoomTemperatures": true,
        "systemStruggleInExtremeSeasons": false
      },
      "images": [
        "https://files.example.com/equipment/hvac-Product.jpeg",
        "https://files.example.com/equipment/hvac-Artemis_Solar_Logo.png"
      ]
    },
    "electricalDetails": {
      "panelAge": "4",
      "panelBrand": "brand-panel",
      "meterCondition": "intact",
      "homeownerQuestions": {
        "breakersTripOften": true,
        "lightsFlickerOrDim": true,
        "meterConditionNotes": "Comments",
        "recentHighPowerAdditions": true
      },
      "mainBreakerAmperage": "150",
      "overheatingOrCorrosionOrDoubleTapsSigns": false,
      "images": [
        "https://files.example.com/equipment/electrical-Artemis_Solar_Logo.png"
      ]
    },
    "atticDetails": {
      "ductsIntact": true,
      "airHandlerFurnace": [
        {
          "age": "6",
          "model": "model-1",
          "location": "basement"
        },
        {
          "age": "4",
          "model": "model-2",
          "location": "closet"
        },
        {
          "age": "2",
          "model": "model-3",
          "location": "garage"
        }
      ],
      "ductsVisibleLeaks": true,
      "homeownerQuestions": {
        "notes": "Notes",
        "rodentsAroundAttic": true,
        "lastInspectionOrAddedDate": "6",
        "hotColdRoomsOrFloorToFloorTemperatureSwings": true
      },
      "atticInsulationLevel": "adequate",
      "atticDraftsNearHatchPenetrations": true,
      "atticSignOfMoisturePestsOrRodents": false,
      "images": [
        "https://files.example.com/equipment/attic-Product.jpeg"
      ]
    },
    "windowDoorsDetails": {
      "windowType": "mixed",
      "draftsAtDoors": true,
      "draftsAtWindows": true,
      "difficultToOperate": true,
      "homeownerQuestions": {
        "notes": "Notes about windows and doors",
        "recentReplacements": true,
        "draftsInSpecificRooms": true,
        "recentReplacementsQuantity": 5,
        "recentReplacementsHowLongAgo": "6"
      },
      "draftsAtDoorsQuantity": 1,
      "draftsAtWindowsQuantity": 1,
      "doublePaneWindowQuantity": 3,
      "singlePaneWindowQuantity": 5,
      "crackedWarpedDamagedFrames": true,
      "difficultToOperateQuantity": 3,
      "condensationFoggingBetweenPanes": true,
      "crackedWarpedDamagedFramesQuantity": 2,
      "condensationFoggingBetweenPanesQuantity": 1,
      "images": [
        "https://files.example.com/equipment/window_doors-Product.jpeg"
      ]
    },
    "lifestyleDetails": {
      "waterHeaterAge": "5",
      "waterHeaterType": "tankless",
      "homeownerQuestions": {
        "notes": "Lifestyle notes",
        "longStayPlanning": true,
        "mostConsumptionEnergyPeriod": "day",
        "comfortSafetyCostConcernsComments": "Concerns notes",
        "electricBillsSpikeDueSeasonChange": true,
        "homeTypicallyOccupiedDuringTheDay": true,
        "solarRenewableOrBackupPowerInterest": true
      },
      "houseCurrentlyHasSolar": true,
      "solarSystemFinanceType": "lease-ppa",
      "houseCurrentlyHasBattery": "yes",
      "receivingTraditionalBills": "no",
      "majorInefficientOrOldAppliances": true,
      "images": [
        "https://files.example.com/equipment/lifestyle-Product.jpeg"
      ]
    },
    "status": "completed",
    "completedAt": "2026-01-07T17:11:14.189Z",
    "createdAt": "2026-01-07T16:20:27.594Z",
    "updatedAt": "2026-01-07T17:11:14.189Z"
  }
}

user-created

Triggered when a new user is created in the organization.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "user-created",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "user",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "href": "/external/v2/users/123e4567-e89b-12d3-a456-426614174000"
  }
}
V1 example payload

Triggered when a new user is created in the organization.

{
  "event": "user-created",
  "data": {
    "id": "u1s2e3r4-c5r6-e7a8-t9e0-d12345abcdef",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phoneNumber": "+1555123456",
    "teams": [
      {
        "id": "t1e2a3m4-i5d6-7890-1234-567890abcdef",
        "name": "Sales Team"
      }
    ],
    "roles": [
      {
        "id": "r1o2l3e4-i5d6-7890-1234-567890abcdef",
        "name": "Sales Representative"
      }
    ],
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
}

user-updated

Triggered when a user is updated.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "user-updated",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "user",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "href": "/external/v2/users/123e4567-e89b-12d3-a456-426614174000"
  }
}
V1 example payload

Triggered when a user is updated.

{
  "event": "user-updated",
  "data": {
    "id": "u1s2e3r4-u5p6-d7a8-t9e0-d12345abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com",
    "phoneNumber": "+1555987654",
    "teams": [
      {
        "id": "t1e2a3m4-i5d6-7890-1234-567890abcdef",
        "name": "Sales Team"
      },
      {
        "id": "t2e3a4m5-i6d7-8901-2345-678901bcdefg",
        "name": "Support Team"
      }
    ],
    "roles": [
      {
        "id": "r1o2l3e4-i5d6-7890-1234-567890abcdef",
        "name": "Sales Representative"
      },
      {
        "id": "r2o3l4e5-i6d7-8901-2345-678901bcdefg",
        "name": "Team Lead"
      }
    ],
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T14:45:00.000Z"
  }
}

user-deleted

Triggered when a user is deleted.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "user-deleted",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "user",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "href": "/external/v2/users/123e4567-e89b-12d3-a456-426614174000"
  }
}
V1 example payload

Triggered when a user is deleted.

{
  "event": "user-deleted",
  "data": {
    "id": "u1s2e3r4-d5e6-l7e8-t9e0-d12345abcdef",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "phoneNumber": "+1555246810",
    "teams": [
      {
        "id": "t1e2a3m4-i5d6-7890-1234-567890abcdef",
        "name": "Sales Team"
      }
    ],
    "roles": [
      {
        "id": "r1o2l3e4-i5d6-7890-1234-567890abcdef",
        "name": "Sales Representative"
      }
    ],
    "deletedAt": "2024-01-25T16:00:00.000Z",
    "createdAt": "2024-01-10T08:00:00.000Z",
    "updatedAt": "2024-01-25T16:00:00.000Z"
  }
}

comment-created

Triggered when a comment is created on a project.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "comment-created",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when a comment is created on a project.

{
  "event": "comment-created",
  "data": {
    "id": "c1o2m3m4-e5n6-t7i8-d9a0-123456abcdef",
    "projectId": "p1r2o3j4-e5c6-t7i8-d9a0-123456abcdef",
    "authorId": "a1u2t3h4-o5r6-i7d8-9a0b-123456abcdef",
    "parentCommentId": null,
    "type": "project",
    "content": "<p>This is a sample comment for the project.</p>",
    "mentions": [
      {
        "userId": "m1e2n3t4-i5o6-n7e8-d9a0-123456abcdef",
        "displayName": "Jane Smith"
      }
    ],
    "isEdited": false,
    "isDeleted": false,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
}

comment-updated

Triggered when a comment is updated.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "comment-updated",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when a comment is updated.

{
  "event": "comment-updated",
  "data": {
    "id": "c1o2m3m4-e5n6-t7i8-d9a0-123456abcdef",
    "projectId": "p1r2o3j4-e5c6-t7i8-d9a0-123456abcdef",
    "authorId": "a1u2t3h4-o5r6-i7d8-9a0b-123456abcdef",
    "parentCommentId": null,
    "type": "project",
    "content": "<p>This is an updated comment with more details.</p>",
    "mentions": [
      {
        "userId": "m1e2n3t4-i5o6-n7e8-d9a0-123456abcdef",
        "displayName": "Jane Smith"
      },
      {
        "userId": "m2e3n4t5-i6o7-n8e9-d0a1-234567bcdefg",
        "displayName": "Bob Johnson"
      }
    ],
    "isEdited": true,
    "isDeleted": false,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T11:00:00.000Z"
  }
}

comment-deleted

Triggered when a comment is soft-deleted.

V2 example payload
{
  "id": "01900000-0000-4000-8000-000000000002",
  "event": "comment-deleted",
  "version": 2,
  "createdAt": "2026-10-07T12:00:00.000Z",
  "resource": {
    "type": "project",
    "id": "b52b31dc-abef-4f9d-8608-c197127b723b",
    "href": "/external/v2/projects/b52b31dc-abef-4f9d-8608-c197127b723b"
  }
}
V1 example payload

Triggered when a comment is soft-deleted.

{
  "event": "comment-deleted",
  "data": {
    "id": "c1o2m3m4-e5n6-t7i8-d9a0-123456abcdef",
    "projectId": "p1r2o3j4-e5c6-t7i8-d9a0-123456abcdef",
    "authorId": "a1u2t3h4-o5r6-i7d8-9a0b-123456abcdef",
    "parentCommentId": null,
    "type": "project",
    "content": "<p>This is a sample comment for the project.</p>",
    "mentions": [],
    "isEdited": false,
    "isDeleted": true,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T12:00:00.000Z"
  }
}