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"
],
"site": {
"id": "5b084d91-3521-4e3d-a1dc-730d19ad0d06",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "ccb1cf6f-2124-4836-92b5-d4b790e066b8",
"name": "string",
"publicId": "4bbe57ae-cbb6-4ba4-9bc0-5a5fc6362ba5"
},
"country": "string",
"created": "2024-12-13T22:35:04.693456313",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "dcb91efe-d2a1-4ae8-a672-5d0412c81fce",
"status": "string",
"updated": "2024-12-13T22:35:04.693469135",
"url": "string"
}connection.updated
Pushes an event when a utility account connection is updated.
Example
JSON
{
"accounts": [
{
"accountNumber": "string",
"datasourceTypes": [
"string"
],
"site": {
"id": "99ec6b60-18ea-45c1-acd5-2411a8c69d0c",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "baaa7703-8d7a-43e3-9693-6e486ddc3660",
"name": "string",
"publicId": "b65c6cbe-a4ee-43ca-80fb-1c736d047d2c"
},
"country": "string",
"created": "2024-12-13T22:35:04.693880440",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "c7be7ff8-43ee-462c-8630-189f24ee01f4",
"protectedChanges": [],
"status": "string",
"updated": "2024-12-13T22:35:04.693892199",
"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": "0ecd7d61-7c5c-4f65-bdf2-0620923934b6",
"name": "string"
},
"created": "2024-12-13T22:35:04.694854239",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2024-12-13",
"dueDate": "2024-12-13",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "bba80191-043d-46d6-9562-acfbf8d9ec6c",
"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",
"additionalFields": {},
"auditTrailUrl": "string",
"billedDemand": "decimal",
"created": "2024-12-13T22:35:04.694909223",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2024-12-13",
"documentId": "28c88a9a-0d15-49bc-9488-008d400bb7d8",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2024-12-13",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "8110d05e-c90b-499e-bb4c-b428981b3207",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2024-12-13T22:35:04.694930608",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "f820f05a-7bf0-479f-9d9b-0be7923720ba",
"siteName": "string",
"startDate": "2024-12-13",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2024-12-13T22:35:04.694941082",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2024-12-13T22:35:04.694958240",
"taxCharges": "decimal",
"taxId": "string",
"totalCharges": "decimal",
"totalChargesUnits": "string",
"totalDocumentCharges": "decimal",
"totalDocumentChargesUnits": "string",
"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": "07bd66ca-7134-4a49-830a-4b7f4a8f33c1",
"name": "string"
},
"created": "2024-12-13T22:35:04.698463643",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2024-12-13",
"dueDate": "2024-12-13",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "99852f96-bcbc-4c36-a903-d2ec3c7ef34d",
"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",
"additionalFields": {},
"auditTrailUrl": "string",
"billedDemand": "decimal",
"created": "2024-12-13T22:35:04.698516133",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2024-12-13",
"documentId": "da3ece16-7769-4678-a171-f178cd49268f",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2024-12-13",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "241f4626-a458-4908-8a5e-a1219d668bad",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2024-12-13T22:35:04.698536812",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "6696294c-076c-4fd6-b411-88a447d1f8bd",
"siteName": "string",
"startDate": "2024-12-13",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2024-12-13T22:35:04.698548415",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2024-12-13T22:35:04.698564213",
"taxCharges": "decimal",
"taxId": "string",
"totalCharges": "decimal",
"totalChargesUnits": "string",
"totalDocumentCharges": "decimal",
"totalDocumentChargesUnits": "string",
"url": "string",
"utilityCompany": "string"
}