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": "a59294a0-0008-4d81-ad8c-843b9875820f",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "5a9301ac-ef03-4d4c-9283-1fd54c0d054f",
"name": "string",
"publicId": "b37aaf0a-c032-440e-b7d4-9e5f2f87890b"
},
"country": "string",
"created": "2025-03-08T08:47:22.961199854",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "1287de65-c88a-4500-93f0-ae10b0c4783b",
"status": "string",
"updated": "2025-03-08T08:47:22.961212718",
"url": "string"
}connection.updated
Pushes an event when a utility account connection is updated.
Example
JSON
{
"accounts": [
{
"accountNumber": "string",
"datasourceTypes": [
"string"
],
"site": {
"id": "6691fb6c-c770-4a97-8bbe-3dc6fc262bd0",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "cbe0f4b0-64b4-4d16-9314-2ac3a3372ef9",
"name": "string",
"publicId": "de867e1b-648b-40c6-b6e0-11c463297512"
},
"country": "string",
"created": "2025-03-08T08:47:22.961811962",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "d187f7f8-072b-4dd9-872b-d525af51ec92",
"protectedChanges": [],
"status": "string",
"updated": "2025-03-08T08:47:22.961823505",
"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"
],
"site": {
"id": "7eb6bbf8-6a53-4dc3-ab32-71bc6b44731a",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "70cca81f-18c3-481c-a406-316c2e247fd5",
"name": "string",
"publicId": "e854d972-902c-45f1-b9cf-77058823128b"
},
"country": "string",
"created": "2025-03-08T08:47:22.962745188",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "71a2f1f6-1368-45f2-ab9c-44037a1132a3",
"protectedChanges": [],
"status": "string",
"updated": "2025-03-08T08:47:22.962756101",
"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": "998e997f-7da2-4a54-8eda-b706bd1ed200",
"name": "string"
},
"created": "2025-03-08T08:47:22.963169649",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-03-08",
"dueDate": "2025-03-08",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "5997d74e-2100-4db2-8404-e68595641eac",
"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-03-08T08:47:22.963224317",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2025-03-08",
"documentId": "fb5c04bf-4863-4c54-b5bd-63ccf9f00103",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2025-03-08",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "41d46a25-1847-4d67-ad1d-cc5aad9a76cb",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-03-08T08:47:22.963244086",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "f271af49-d9d4-44d8-9e29-8186d6e292c7",
"siteName": "string",
"startDate": "2025-03-08",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2025-03-08T08:47:22.963254526",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-03-08T08:47:22.963270428",
"taxCharges": "decimal",
"taxId": "string",
"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": "6e1f3812-587f-47e8-a87e-4c6186e56bf2",
"name": "string"
},
"created": "2025-03-08T08:47:22.966652059",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-03-08",
"dueDate": "2025-03-08",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "05566956-6ec6-4233-9d19-ce3a4ef08c7d",
"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-03-08T08:47:22.966705186",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2025-03-08",
"documentId": "58574307-224c-46c2-98b7-10da12fd8720",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2025-03-08",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "6c16956f-d20f-4ee4-835d-7b67e270edc3",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-03-08T08:47:22.966724641",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "550c617f-6c98-4f6f-a9ac-e727cb7921d1",
"siteName": "string",
"startDate": "2025-03-08",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2025-03-08T08:47:22.966735878",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-03-08T08:47:22.966751611",
"taxCharges": "decimal",
"taxId": "string",
"totalCharges": "decimal",
"url": "string",
"utilityCompany": "string"
}