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-04-23",
"isTracked": true,
"startDate": "2025-04-23"
}
],
"company": {
"externalId": "string",
"id": "5913397a-3525-4320-9825-cc2bdb24f667",
"name": "string"
},
"country": "string",
"created": "2025-04-23T06:20:30.664727965",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "cd222e98-ad79-48ef-b65a-b2685a339333",
"status": "string",
"updated": "2025-04-23T06:20:30.664737275",
"url": "string"
}connection.updated
Pushes an event when a utility account connection is updated.
Example
JSON
{
"accounts": [
{
"accountNumber": "string",
"datasourceTypes": [
"string"
],
"endDate": "2025-04-23",
"isTracked": true,
"startDate": "2025-04-23"
}
],
"company": {
"externalId": "string",
"id": "72ce1a92-7178-4f60-bde0-95d5d3372a26",
"name": "string"
},
"country": "string",
"created": "2025-04-23T06:20:30.664959411",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "dfa5b5df-6494-4319-8748-c1a3798608f9",
"protectedChanges": [],
"status": "string",
"updated": "2025-04-23T06:20:30.664967121",
"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-04-23",
"isTracked": true,
"startDate": "2025-04-23"
}
],
"company": {
"externalId": "string",
"id": "16aad894-d650-416a-9116-d43822d1f2f8",
"name": "string"
},
"country": "string",
"created": "2025-04-23T06:20:30.665321950",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "3967148b-52b6-4754-bb10-0b591ce5372f",
"protectedChanges": [],
"status": "string",
"updated": "2025-04-23T06:20:30.665330760",
"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": "84c6e9b3-99ff-4418-a83e-f9dcb5e52a5e",
"name": "string"
},
"created": "2025-04-23T06:20:30.665632447",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-04-23",
"dueDate": "2025-04-23",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "3239e8f7-8684-4077-8997-e8bf25361142",
"interestCharges": "decimal",
"invoiceId": "string",
"isFlagged": true,
"lineItems": [
{
"accountIds": [
"string"
],
"description": "string",
"electricityIsDemand": true,
"electricityTimeOfUse": "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-04-23T06:20:30.665673808",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2025-04-23",
"documentId": "4a6e6a0b-9d74-42b2-b8b0-ba0db90f7931",
"documentNotes": "string",
"documentSourceType": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2025-04-23",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "8d379287-13cf-4a43-9637-47fe624e9033",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-04-23T06:20:30.665690809",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "65bc08c6-2434-48f5-bc92-ea85bff12a23",
"siteName": "string",
"startDate": "2025-04-23",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2025-04-23T06:20:30.665698749",
"usage": "string",
"utilityCompany": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-04-23T06:20:30.665710929",
"revisedDocumentId": "string",
"sourceType": "string",
"supersededDocumentIds": "string",
"taxCharges": "decimal",
"totalCharges": "decimal",
"url": "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": "42c293d3-d466-4d9e-8854-40efa6523a60",
"name": "string"
},
"created": "2025-04-23T06:20:30.667835812",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-04-23",
"dueDate": "2025-04-23",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "559f5480-7182-4d7d-aa97-35a2be5ceda1",
"interestCharges": "decimal",
"invoiceId": "string",
"isFlagged": true,
"lineItems": [
{
"accountIds": [
"string"
],
"description": "string",
"electricityIsDemand": true,
"electricityTimeOfUse": "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-04-23T06:20:30.667877083",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2025-04-23",
"documentId": "87d821d2-154d-4262-972f-322b84e473ce",
"documentNotes": "string",
"documentSourceType": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2025-04-23",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "79abbc2f-c064-4473-b53c-7289b1a30b60",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-04-23T06:20:30.667893914",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "7fc3c6b9-8a5b-4abe-902b-f23c1ecefe27",
"siteName": "string",
"startDate": "2025-04-23",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2025-04-23T06:20:30.667903674",
"usage": "string",
"utilityCompany": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-04-23T06:20:30.667915554",
"revisedDocumentId": "string",
"sourceType": "string",
"supersededDocumentIds": "string",
"taxCharges": "decimal",
"totalCharges": "decimal",
"url": "string",
"utilityCompany": "string"
}