Webhook

Nectar Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

connection.created

Pushes an event when a utility account connection is created.

Example
JSON
{
  "accounts": [
    {
      "accountNumber": "string",
      "datasourceTypes": [
        "string"
      ],
      "endDate": "2025-05-10",
      "isTracked": true,
      "startDate": "2025-05-10"
    }
  ],
  "company": {
    "externalId": "string",
    "id": "347b367d-ae6e-42cb-b998-3e7fb9ec6d58",
    "name": "string"
  },
  "country": "string",
  "created": "2025-05-10T00:41:17.398683402",
  "datasource": {
    "name": "string"
  },
  "emails": [
    "email"
  ],
  "eventType": "string",
  "id": "a7685b41-39c2-4fd1-aceb-f99198ffeaf5",
  "status": "string",
  "updated": "2025-05-10T00:41:17.398693003",
  "url": "string"
}

connection.created.v2

Pushes an event when a utility account connection is created. V2 format with enhanced data.

Example
JSON
{
  "accounts": [
    {
      "accountNumber": "string",
      "dataCollectionStartDate": "2025-09-13",
      "datasourceTypes": [
        "string"
      ],
      "id": "36a959af-06d8-44ad-a471-b162325d22d0",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-09-13",
      "meters": [
        "17c16106-45cc-455b-84da-cd7061338ad0"
      ]
    }
  ],
  "country": "string",
  "created": "2025-09-13T02:35:00.713009225",
  "dataCollectionStartDate": "2025-09-13",
  "eventType": "string",
  "id": "a8d90752-3a35-4594-a6f7-0dea7dc57b4b",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "ebe87084-c9d4-491f-b562-359fe3d4c531"
  ],
  "multiplyByOccupancy": true,
  "status": "string",
  "updated": "2025-09-13T02:35:00.713024315",
  "url": "string",
  "username": "string",
  "workflowOwnerEmail": "email"
}

connection.updated

Pushes an event when a utility account connection is updated.

Example
JSON
{
  "accounts": [
    {
      "accountNumber": "string",
      "datasourceTypes": [
        "string"
      ],
      "endDate": "2025-05-10",
      "isTracked": true,
      "startDate": "2025-05-10"
    }
  ],
  "company": {
    "externalId": "string",
    "id": "b492a1a8-4a95-4fd1-a80e-74acf4ca006d",
    "name": "string"
  },
  "country": "string",
  "created": "2025-05-10T00:41:17.399085912",
  "datasource": {
    "name": "string"
  },
  "emails": [
    "email"
  ],
  "eventType": "string",
  "id": "b0b935f9-cf91-4da7-b0b3-86d665532608",
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-05-10T00:41:17.399093962",
  "url": "string"
}

connection.updated.v2

Pushes an event when a utility account connection is updated. V2 format with enhanced data.

Example
JSON
{
  "accounts": [
    {
      "accountNumber": "string",
      "dataCollectionStartDate": "2025-09-13",
      "datasourceTypes": [
        "string"
      ],
      "id": "80b80d64-bb24-4e31-8bac-a41fbd344110",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-09-13",
      "meters": [
        "c20af046-02e9-424e-9900-e137d7786977"
      ]
    }
  ],
  "country": "string",
  "created": "2025-09-13T02:35:00.717149653",
  "dataCollectionStartDate": "2025-09-13",
  "eventType": "string",
  "id": "1ef7a113-b004-4a49-8035-71d371f016dc",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "b1de0d83-cf4a-46ae-9d47-fc7263732a3a"
  ],
  "multiplyByOccupancy": true,
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-09-13T02:35:00.717193530",
  "url": "string",
  "username": "string",
  "workflowOwnerEmail": "email"
}

connection.validated

Pushes an event when a utility account connection is updated or validated by the Nectar system.

Example
JSON
{
  "accounts": [
    {
      "accountNumber": "string",
      "datasourceTypes": [
        "string"
      ],
      "endDate": "2025-05-10",
      "isTracked": true,
      "startDate": "2025-05-10"
    }
  ],
  "company": {
    "externalId": "string",
    "id": "c559fcfe-3b78-47a1-acfb-55a2880518fa",
    "name": "string"
  },
  "country": "string",
  "created": "2025-05-10T00:41:17.399683496",
  "datasource": {
    "name": "string"
  },
  "emails": [
    "email"
  ],
  "eventType": "string",
  "id": "73ca7bb7-5f5c-48c2-ac24-db17cc09f221",
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-05-10T00:41:17.399690926",
  "url": "string"
}

connection.validated.v2

Pushes an event when a utility account connection is validated. V2 format with enhanced data.

Example
JSON
{
  "accounts": [
    {
      "accountNumber": "string",
      "dataCollectionStartDate": "2025-09-13",
      "datasourceTypes": [
        "string"
      ],
      "id": "5ebf9b85-f58b-4c57-997d-b1326bf64e06",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-09-13",
      "meters": [
        "044c7918-6105-4e0e-83dd-b1e5e4525d56"
      ]
    }
  ],
  "country": "string",
  "created": "2025-09-13T02:35:00.724105058",
  "dataCollectionStartDate": "2025-09-13",
  "eventType": "string",
  "id": "ac676876-2492-414d-aecb-5cd3af1f88dd",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "c398efb7-e12f-4d16-89b8-9bc31f432ab9"
  ],
  "multiplyByOccupancy": true,
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-09-13T02:35:00.724150507",
  "url": "string",
  "username": "string",
  "workflowOwnerEmail": "email"
}

document.created

Pushes an event when a document is created.

Example
JSON
{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "chargesUnits": "string",
  "company": {
    "externalId": "string",
    "id": "4ee0cb09-f4ce-4fa9-8722-d102afc161fa",
    "name": "string"
  },
  "created": "2025-05-10T00:41:17.399982233",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "documentDate": "2025-05-10",
  "dueDate": "2025-05-10",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "eventType": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "9673acab-8c19-4ff0-9c75-1029079263f8",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "billingPeriod": "string",
      "chargeType": "string",
      "description": "string",
      "electricityChargeType": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "gasChargeType": "string",
      "meterIds": [
        "string"
      ],
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "meterSiteUsageData": [
    {
      "accountId": "string",
      "accountIsTracked": true,
      "additionalFields": {},
      "auditTrailUrl": "string",
      "billedDemand": "decimal",
      "created": "2025-05-10T00:41:17.400026715",
      "currentReading": "decimal",
      "customContainerName": "string",
      "customContainerSize": "decimal",
      "customContainerUnits": "string",
      "customContainerUsage": "decimal",
      "datasourceType": "string",
      "daysInRange": 42,
      "documentDate": "2025-05-10",
      "documentId": "ee1fbd0a-7bc4-474c-b986-7384ea9138a7",
      "documentNotes": "string",
      "documentSourceType": "string",
      "endDate": "2025-05-10",
      "exclusion": true,
      "icp": "string",
      "id": "7c3a7372-8ec4-4a52-aeea-fb4bf1fad811",
      "identifiers": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isFlagged": true,
      "isImplied": true,
      "meterId": "string",
      "podId": "string",
      "previousReading": "decimal",
      "processedDate": "2025-05-10T00:41:17.400049665",
      "shopNumber": "string",
      "siteAddress": "string",
      "siteExternalId": "string",
      "siteId": "0e0fa7dc-aa3f-4394-a05f-db22e113db83",
      "siteName": "string",
      "startDate": "2025-05-10",
      "submeterId": "string",
      "supplierName": "string",
      "tariff": "string",
      "totalDocumentCharges": "decimal",
      "totalDocumentChargesUnits": "string",
      "updated": "2025-05-10T00:41:17.400063215",
      "usage": "string",
      "usageUnits": "string",
      "utilityCompany": "string"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "processedDate": "2025-05-10T00:41:17.400079966",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "url": "string",
  "utilityCompany": "string"
}

document.created.v2

Pushes an event when a document is created. V2 format with enhanced data.

Example
JSON
{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "billDate": "2025-09-13",
  "chargesUnits": "string",
  "company": "77f25a0a-62cf-4f81-b4bd-f856285bf792",
  "created": "2025-09-13T02:35:00.724774419",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "dueDate": "2025-09-13",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "email": "email",
  "eventType": "string",
  "fileName": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "aaf7e034-0021-4461-a210-508012fba6b2",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "jobId": "string",
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "description": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "status": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "updated": "2025-09-13T02:35:00.724856154",
  "url": "string",
  "usageData": [
    {
      "additionalFields": {},
      "billedDemand": "decimal",
      "country": "string",
      "created": "2025-09-13T02:35:00.725014376",
      "currentReading": "decimal",
      "endDate": "2025-09-13",
      "exclusion": true,
      "fractionRenewable": "decimal",
      "id": "961276d3-050d-49e4-a2f3-06c5302b76cd",
      "identifiers": [
        {
          "name": "string",
          "rawName": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isImplied": true,
      "meter": "string",
      "meterAddress": "string",
      "meterIsTracked": true,
      "multiplier": "decimal",
      "multiplier2": "decimal",
      "multiplier2Description": "string",
      "multiplierDescription": "string",
      "netMeteringGeneratedKwh": "decimal",
      "netMeteringGridExportKwh": "decimal",
      "netMeteringGridImportKwh": "decimal",
      "previousReading": "decimal",
      "serviceAddress": "string",
      "startDate": "2025-09-13",
      "supplierName": "string",
      "tariff": "string",
      "updated": "2025-09-13T02:35:00.725066032",
      "usage": "string",
      "utilityName": "string",
      "wasteDescription": "string",
      "wasteStream": "string",
      "wasteType": "string"
    }
  ],
  "utilityCompany": "string"
}

document.updated

Pushes an event when a document is updated.

Example
JSON
{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "chargesUnits": "string",
  "company": {
    "externalId": "string",
    "id": "e9a82440-66e9-486a-90f7-4054e53ef793",
    "name": "string"
  },
  "created": "2025-05-10T00:41:17.402149345",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "documentDate": "2025-05-10",
  "dueDate": "2025-05-10",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "eventType": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "d730cd17-75a7-4ff4-8af0-850461749301",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "billingPeriod": "string",
      "chargeType": "string",
      "description": "string",
      "electricityChargeType": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "gasChargeType": "string",
      "meterIds": [
        "string"
      ],
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "meterSiteUsageData": [
    {
      "accountId": "string",
      "accountIsTracked": true,
      "additionalFields": {},
      "auditTrailUrl": "string",
      "billedDemand": "decimal",
      "created": "2025-05-10T00:41:17.402195166",
      "currentReading": "decimal",
      "customContainerName": "string",
      "customContainerSize": "decimal",
      "customContainerUnits": "string",
      "customContainerUsage": "decimal",
      "datasourceType": "string",
      "daysInRange": 42,
      "documentDate": "2025-05-10",
      "documentId": "3ca0b273-3de6-480d-b751-109218be3584",
      "documentNotes": "string",
      "documentSourceType": "string",
      "endDate": "2025-05-10",
      "exclusion": true,
      "icp": "string",
      "id": "b6091ede-7e9e-422e-9335-277c98d94c4f",
      "identifiers": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isFlagged": true,
      "isImplied": true,
      "meterId": "string",
      "podId": "string",
      "previousReading": "decimal",
      "processedDate": "2025-05-10T00:41:17.402217447",
      "shopNumber": "string",
      "siteAddress": "string",
      "siteExternalId": "string",
      "siteId": "8be64e22-8b82-484b-97b5-6ae04778874d",
      "siteName": "string",
      "startDate": "2025-05-10",
      "submeterId": "string",
      "supplierName": "string",
      "tariff": "string",
      "totalDocumentCharges": "decimal",
      "totalDocumentChargesUnits": "string",
      "updated": "2025-05-10T00:41:17.402230587",
      "usage": "string",
      "usageUnits": "string",
      "utilityCompany": "string"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "processedDate": "2025-05-10T00:41:17.402248308",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "url": "string",
  "utilityCompany": "string"
}

document.updated.v2

Pushes an event when a document is updated. V2 format with enhanced data.

Example
JSON
{
  "afterPreviousCharges": "decimal",
  "afterPreviousCredits": "decimal",
  "afterPreviousTotalPayment": "decimal",
  "auditTrailUrl": "string",
  "billDate": "2025-09-13",
  "chargesUnits": "string",
  "company": "3b54d3ba-6b2e-4546-9e4c-26fbce04a3b7",
  "created": "2025-09-13T02:35:00.734163986",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "dueDate": "2025-09-13",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "email": "email",
  "eventType": "string",
  "fileName": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "264b41c9-c245-4fbb-a9f7-bcf41aa0d87e",
  "interestCharges": "decimal",
  "invoiceId": "string",
  "isFlagged": true,
  "jobId": "string",
  "lineItems": [
    {
      "accountIds": [
        "string"
      ],
      "description": "string",
      "electricityIsDemand": true,
      "electricityTimeOfUse": "string",
      "multipliers": [
        "decimal"
      ],
      "quantity": "decimal",
      "quantityUnits": "string",
      "rate": "decimal",
      "totalCharge": "decimal"
    }
  ],
  "notes": "string",
  "previousCloseBalance": "decimal",
  "revisedDocumentId": "string",
  "sourceType": "string",
  "status": "string",
  "supersededDocumentIds": [
    "string"
  ],
  "taxCharges": "decimal",
  "totalCharges": "decimal",
  "updated": "2025-09-13T02:35:00.734414237",
  "url": "string",
  "usageData": [
    {
      "additionalFields": {},
      "billedDemand": "decimal",
      "country": "string",
      "created": "2025-09-13T02:35:00.734546744",
      "currentReading": "decimal",
      "endDate": "2025-09-13",
      "exclusion": true,
      "fractionRenewable": "decimal",
      "id": "31bb039d-609d-4757-a325-0696bdfa5153",
      "identifiers": [
        {
          "name": "string",
          "rawName": "string",
          "value": "string"
        }
      ],
      "isEstimated": true,
      "isImplied": true,
      "meter": "string",
      "meterAddress": "string",
      "meterIsTracked": true,
      "multiplier": "decimal",
      "multiplier2": "decimal",
      "multiplier2Description": "string",
      "multiplierDescription": "string",
      "netMeteringGeneratedKwh": "decimal",
      "netMeteringGridExportKwh": "decimal",
      "netMeteringGridImportKwh": "decimal",
      "previousReading": "decimal",
      "serviceAddress": "string",
      "startDate": "2025-09-13",
      "supplierName": "string",
      "tariff": "string",
      "updated": "2025-09-13T02:35:00.734604625",
      "usage": "string",
      "utilityName": "string",
      "wasteDescription": "string",
      "wasteStream": "string",
      "wasteType": "string"
    }
  ],
  "utilityCompany": "string"
}