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-10-14",
      "datasourceTypes": [
        "string"
      ],
      "id": "eeddaf35-e4b8-44e0-b858-9b08b5c96984",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-10-14",
      "meters": [
        "1ae0aa51-a694-4e23-81e3-7c23ecfc4324"
      ]
    }
  ],
  "country": "string",
  "created": "2025-10-14T09:37:30.788197362",
  "dataCollectionStartDate": "2025-10-14",
  "eventType": "string",
  "id": "2be6c129-9da0-40de-9056-900b80965362",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "8976bbb5-11cc-4cea-9ffa-6932dc74be49"
  ],
  "multiplyByOccupancy": true,
  "status": "string",
  "updated": "2025-10-14T09:37:30.788209068",
  "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-10-14",
      "datasourceTypes": [
        "string"
      ],
      "id": "8834bdfe-2f3a-4040-a487-2d114607b53a",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-10-14",
      "meters": [
        "2abaf417-9a4d-418d-87f0-02cbe8bce185"
      ]
    }
  ],
  "country": "string",
  "created": "2025-10-14T09:37:30.788790026",
  "dataCollectionStartDate": "2025-10-14",
  "eventType": "string",
  "id": "b1550fb2-8cc4-4001-8a9a-8ee132495a17",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "43dba670-d09a-413b-8d5c-3a8d4ebb2298"
  ],
  "multiplyByOccupancy": true,
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-10-14T09:37:30.788820946",
  "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-10-14",
      "datasourceTypes": [
        "string"
      ],
      "id": "6325198c-b618-49e8-abaf-7640df94b8fd",
      "isCollectingInvoiceData": true,
      "isCollectingSmartMeterData": true,
      "isDuplicated": "string",
      "isTracked": true,
      "lastServiceDate": "2025-10-14",
      "meters": [
        "a83dba6f-1cd8-408f-a88c-0021ef9d5f72"
      ]
    }
  ],
  "country": "string",
  "created": "2025-10-14T09:37:30.791993995",
  "dataCollectionStartDate": "2025-10-14",
  "eventType": "string",
  "id": "ea64393f-6996-4a43-9a1f-b399d3c12922",
  "initialDatasourceTypes": [
    "string"
  ],
  "initialSites": [
    "ab9e7f51-998c-40f9-8791-76f10a9f2b8a"
  ],
  "multiplyByOccupancy": true,
  "protectedChanges": [],
  "status": "string",
  "updated": "2025-10-14T09:37:30.792031536",
  "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-10-14",
  "chargesUnits": "string",
  "company": "cd353fed-4113-4b99-a6bf-8a0dc4687845",
  "created": "2025-10-14T09:37:30.792425559",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "dueDate": "2025-10-14",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "email": "email",
  "eventType": "string",
  "fileName": "string",
  "flaggedStatus": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "c6794e9a-9cb5-40ff-b1c9-e4e4340d9a5c",
  "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-10-14T09:37:30.792474310",
  "url": "string",
  "usageData": [
    {
      "additionalFields": {},
      "billedDemand": "decimal",
      "country": "string",
      "created": "2025-10-14T09:37:30.792586615",
      "currentReading": "decimal",
      "endDate": "2025-10-14",
      "exclusion": true,
      "fractionRenewable": "decimal",
      "id": "6236c1af-ad01-4d4b-9fad-e6a782b20764",
      "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-10-14",
      "supplierName": "string",
      "tariff": "string",
      "updated": "2025-10-14T09:37:30.792622444",
      "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-10-14",
  "chargesUnits": "string",
  "company": "84361a93-2348-4544-ab5d-2eaf7b64135e",
  "created": "2025-10-14T09:37:30.796786229",
  "credits": "decimal",
  "currentCharges": "decimal",
  "currentOpenBalance": "decimal",
  "dueDate": "2025-10-14",
  "electricityDeliveryCharges": "decimal",
  "electricityDemandCharges": "decimal",
  "electricitySupplyCharges": "decimal",
  "email": "email",
  "eventType": "string",
  "fileName": "string",
  "flaggedStatus": "string",
  "gasDeliveryCharges": "decimal",
  "gasSupplyCharges": "decimal",
  "id": "5e5163b4-927b-4cb2-8c92-6b5aa1576235",
  "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-10-14T09:37:30.796915428",
  "url": "string",
  "usageData": [
    {
      "additionalFields": {},
      "billedDemand": "decimal",
      "country": "string",
      "created": "2025-10-14T09:37:30.797006721",
      "currentReading": "decimal",
      "endDate": "2025-10-14",
      "exclusion": true,
      "fractionRenewable": "decimal",
      "id": "b9626027-63b0-4b06-bb10-bcaf9fa1ae17",
      "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-10-14",
      "supplierName": "string",
      "tariff": "string",
      "updated": "2025-10-14T09:37:30.797047802",
      "usage": "string",
      "utilityName": "string",
      "wasteDescription": "string",
      "wasteStream": "string",
      "wasteType": "string"
    }
  ],
  "utilityCompany": "string"
}