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-05-30",
"id": "6a3fb773-6a1b-4706-94e7-af89d41b8526",
"isCollectingInvoiceData": true,
"isCollectingSmartMeterData": true,
"isDuplicated": true,
"isTracked": true,
"meters": [
"a8632124-7a24-4beb-bdfc-6c1124a001b6"
]
}
],
"company": {
"externalId": "string",
"id": "3bc3f4ce-ee08-4acc-9ed8-c57033481451",
"name": "string"
},
"country": "string",
"created": "2025-05-30T22:11:25.147377632",
"datasource": {
"name": "string",
"url": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "3aaa0985-b5e8-4243-a75d-d070824ce0b4",
"status": "string",
"updated": "2025-05-30T22:11:25.147389228",
"url": "string"
}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-05-30",
"id": "2d7d9956-1291-4d37-ad30-87cd0656b26b",
"isCollectingInvoiceData": true,
"isCollectingSmartMeterData": true,
"isDuplicated": true,
"isTracked": true,
"meters": [
"e623afe4-fa41-4ffa-87fe-6ba3080f1001"
]
}
],
"company": {
"externalId": "string",
"id": "5c4ca579-ab35-4821-9320-cc8163e33b61",
"name": "string"
},
"country": "string",
"created": "2025-05-30T22:11:25.147678488",
"datasource": {
"name": "string",
"url": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "1153e90c-0b4a-47f7-a758-75c55280422b",
"protectedChanges": [],
"status": "string",
"updated": "2025-05-30T22:11:25.147690009",
"url": "string"
}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-05-30",
"id": "8fe5bc70-4a92-424b-9af5-2d6b0815cf48",
"isCollectingInvoiceData": true,
"isCollectingSmartMeterData": true,
"isDuplicated": true,
"isTracked": true,
"meters": [
"9de5489b-d6ba-4169-ae4a-09f1ed98235a"
]
}
],
"company": {
"externalId": "string",
"id": "3515a086-f190-4e98-9f7a-2022753a21b9",
"name": "string"
},
"country": "string",
"created": "2025-05-30T22:11:25.148132414",
"datasource": {
"name": "string",
"url": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "2e63222c-b7c5-4c38-81d5-5f534a0284c8",
"protectedChanges": [],
"status": "string",
"updated": "2025-05-30T22:11:25.148143005",
"url": "string"
}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-05-30",
"chargesUnits": "string",
"company": "bdff6c5c-3798-49f3-8483-65db336a3372",
"created": "2025-05-30T22:11:25.148563982",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"dueDate": "2025-05-30",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"email": "email",
"eventType": "string",
"fileName": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "23823cd2-5693-4a65-beec-9da5a4972521",
"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",
"supersededDocumentIds": [
"string"
],
"taxCharges": "decimal",
"totalCharges": "decimal",
"updated": "2025-05-30T22:11:25.148601730",
"url": "string",
"usageData": [
{
"billedDemand": "decimal",
"country": "string",
"created": "2025-05-30T22:11:25.148615666",
"currentReading": "decimal",
"datasourceType": "string",
"districtMediumType": "string",
"districtType": "string",
"endDate": "2025-05-30",
"exclusion": true,
"fractionRenewable": "decimal",
"fuelType": "string",
"gasType": "string",
"id": "a8249e0a-be1e-46ac-8fbb-6225ddc52c90",
"identifiers": [
{
"value": "string"
}
],
"isEstimated": true,
"isImplied": true,
"meter": "string",
"meterHighLow": "string",
"multiplier": "decimal",
"multiplier2": "decimal",
"multiplier2Description": "string",
"multiplierDescription": "string",
"netMeteringGeneratedKwh": "decimal",
"netMeteringGridExportKwh": "decimal",
"netMeteringGridImportKwh": "decimal",
"netMeteringType": "string",
"previousReading": "decimal",
"refrigerantType": "string",
"serviceAddress": "string",
"startDate": "2025-05-30",
"supplierName": "string",
"tariff": "string",
"timeOfUse": "string",
"updated": "2025-05-30T22:11:25.148639829",
"usage": "string",
"wasteDescription": "string",
"waterType": "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-05-30",
"chargesUnits": "string",
"company": "8588b740-5d9f-4322-9c23-06427133ece5",
"created": "2025-05-30T22:11:25.150832241",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"dueDate": "2025-05-30",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"email": "email",
"eventType": "string",
"fileName": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "b8f672b5-7383-4281-8e44-bce44c362f29",
"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",
"supersededDocumentIds": [
"string"
],
"taxCharges": "decimal",
"totalCharges": "decimal",
"updated": "2025-05-30T22:11:25.150871072",
"url": "string",
"usageData": [
{
"billedDemand": "decimal",
"country": "string",
"created": "2025-05-30T22:11:25.150883099",
"currentReading": "decimal",
"datasourceType": "string",
"districtMediumType": "string",
"districtType": "string",
"endDate": "2025-05-30",
"exclusion": true,
"fractionRenewable": "decimal",
"fuelType": "string",
"gasType": "string",
"id": "818b5119-3c42-4ad2-ab44-46c4a09f4cf8",
"identifiers": [
{
"value": "string"
}
],
"isEstimated": true,
"isImplied": true,
"meter": "string",
"meterHighLow": "string",
"multiplier": "decimal",
"multiplier2": "decimal",
"multiplier2Description": "string",
"multiplierDescription": "string",
"netMeteringGeneratedKwh": "decimal",
"netMeteringGridExportKwh": "decimal",
"netMeteringGridImportKwh": "decimal",
"netMeteringType": "string",
"previousReading": "decimal",
"refrigerantType": "string",
"serviceAddress": "string",
"startDate": "2025-05-30",
"supplierName": "string",
"tariff": "string",
"timeOfUse": "string",
"updated": "2025-05-30T22:11:25.150906672",
"usage": "string",
"wasteDescription": "string",
"waterType": "string"
}
],
"utilityCompany": "string"
}