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-16",
"datasourceTypes": [
"string"
],
"id": "0e65c56e-4caf-454b-bebf-ced577a2b0b5",
"isCollectingInvoiceData": true,
"isCollectingSmartMeterData": true,
"isDuplicated": "string",
"isTracked": true,
"lastServiceDate": "2025-09-16",
"meters": [
"9a4838bd-e56a-4dfb-8b46-5b320e1b8130"
]
}
],
"country": "string",
"created": "2025-09-16T22:10:45.435400452",
"dataCollectionStartDate": "2025-09-16",
"eventType": "string",
"id": "67e624f2-a314-4594-b8a9-3fd35c24ace7",
"initialDatasourceTypes": [
"string"
],
"initialSites": [
"87d1b984-bdb5-44a1-b4b1-7da41970a89f"
],
"multiplyByOccupancy": true,
"status": "string",
"updated": "2025-09-16T22:10:45.435416518",
"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-16",
"datasourceTypes": [
"string"
],
"id": "c9a0ba8f-c4b5-461a-bc0a-934d613fa29c",
"isCollectingInvoiceData": true,
"isCollectingSmartMeterData": true,
"isDuplicated": "string",
"isTracked": true,
"lastServiceDate": "2025-09-16",
"meters": [
"9b920c3d-70d3-46b0-9a21-2196ef1bd0b6"
]
}
],
"country": "string",
"created": "2025-09-16T22:10:45.436335704",
"dataCollectionStartDate": "2025-09-16",
"eventType": "string",
"id": "411d60bc-9219-4729-9817-a836ae747da0",
"initialDatasourceTypes": [
"string"
],
"initialSites": [
"e74fa20d-6cf3-472d-9f48-4dfa3f0e4e4c"
],
"multiplyByOccupancy": true,
"protectedChanges": [],
"status": "string",
"updated": "2025-09-16T22:10:45.436379668",
"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-16",
"datasourceTypes": [
"string"
],
"id": "b3088159-9168-45c0-a7bb-6b497f29582c",
"isCollectingInvoiceData": true,
"isCollectingSmartMeterData": true,
"isDuplicated": "string",
"isTracked": true,
"lastServiceDate": "2025-09-16",
"meters": [
"6d2a37d9-29d2-42f5-be92-f21eb26bf7f3"
]
}
],
"country": "string",
"created": "2025-09-16T22:10:45.442627039",
"dataCollectionStartDate": "2025-09-16",
"eventType": "string",
"id": "d1eb54ce-15cc-4e56-b865-2ed1393ca4db",
"initialDatasourceTypes": [
"string"
],
"initialSites": [
"241e957b-1f0b-48fb-8ec2-5ebe424de23c"
],
"multiplyByOccupancy": true,
"protectedChanges": [],
"status": "string",
"updated": "2025-09-16T22:10:45.442670785",
"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-16",
"chargesUnits": "string",
"company": "9ae9ac28-4127-4fac-b460-24337da00cf3",
"created": "2025-09-16T22:10:45.443590175",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"dueDate": "2025-09-16",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"email": "email",
"eventType": "string",
"fileName": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "813404c1-8960-4705-9dcf-a2555f66e567",
"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-16T22:10:45.443673809",
"url": "string",
"usageData": [
{
"additionalFields": {},
"billedDemand": "decimal",
"country": "string",
"created": "2025-09-16T22:10:45.443891799",
"currentReading": "decimal",
"endDate": "2025-09-16",
"exclusion": true,
"fractionRenewable": "decimal",
"id": "7186e981-efeb-4e63-93fb-83ff7b6ae166",
"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-16",
"supplierName": "string",
"tariff": "string",
"updated": "2025-09-16T22:10:45.443979312",
"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-16",
"chargesUnits": "string",
"company": "ac98269d-4857-4c13-9155-f83e21cb2f4c",
"created": "2025-09-16T22:10:45.451919286",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"dueDate": "2025-09-16",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"email": "email",
"eventType": "string",
"fileName": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "c1a577b9-525c-4817-abdd-1ea607d143e5",
"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-16T22:10:45.452103807",
"url": "string",
"usageData": [
{
"additionalFields": {},
"billedDemand": "decimal",
"country": "string",
"created": "2025-09-16T22:10:45.452227013",
"currentReading": "decimal",
"endDate": "2025-09-16",
"exclusion": true,
"fractionRenewable": "decimal",
"id": "93c0d197-992d-4710-aab8-aad87e8ad25e",
"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-16",
"supplierName": "string",
"tariff": "string",
"updated": "2025-09-16T22:10:45.452289320",
"usage": "string",
"utilityName": "string",
"wasteDescription": "string",
"wasteStream": "string",
"wasteType": "string"
}
],
"utilityCompany": "string"
}