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": "36569af7-5f0d-4429-a678-3de77c759a2b",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "c1445133-4468-43be-8e4d-5353dabe2d68",
"name": "string",
"publicId": "68dc6f33-2aea-462f-b7d1-2aafa75134d7"
},
"country": "string",
"created": "2025-02-05T08:11:31.154865317",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "a21b20b4-9d32-4163-939f-95da10eaee3d",
"status": "string",
"updated": "2025-02-05T08:11:31.154879814",
"url": "string"
}connection.updated
Pushes an event when a utility account connection is updated.
Example
JSON
{
"accounts": [
{
"accountNumber": "string",
"datasourceTypes": [
"string"
],
"site": {
"id": "f7655846-64e4-4b24-9ac8-89a1a9861724",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "7e588ee3-66e1-40ee-903e-ac9c2f1a34ca",
"name": "string",
"publicId": "5f9d6fbc-65f5-4665-a71c-f9060d3cf32c"
},
"country": "string",
"created": "2025-02-05T08:11:31.155427057",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "4c2c0ccf-8b18-4d51-b027-9e5e9959c1a9",
"protectedChanges": [],
"status": "string",
"updated": "2025-02-05T08:11:31.155437940",
"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": "5bca957d-11ee-4ecf-a247-d029c9fed572",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "95532299-72ce-4b5d-84be-6bef9f825981",
"name": "string",
"publicId": "f7b70943-b94d-4172-ae28-50ffe3b99c31"
},
"country": "string",
"created": "2025-02-05T08:11:31.156394903",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "9d6e84a8-93a7-4e2d-857e-8685dce274e7",
"protectedChanges": [],
"status": "string",
"updated": "2025-02-05T08:11:31.156408581",
"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": "4bce3bc9-8530-4246-887b-769a7ba5919b",
"name": "string"
},
"created": "2025-02-05T08:11:31.156864961",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-02-05",
"dueDate": "2025-02-05",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "fb1c4f41-d504-4225-baeb-bbc5ad3165e6",
"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": "2025-02-05T08:11:31.156936201",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2025-02-05",
"documentId": "c0ad6501-78c8-4b20-bd4f-04ba944f79dc",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2025-02-05",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "41ae0a56-ea96-4042-a509-423eb88e3cc2",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-02-05T08:11:31.156958248",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "59d3430b-ef6a-4ba0-ad9c-911a838206ee",
"siteName": "string",
"startDate": "2025-02-05",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2025-02-05T08:11:31.156968849",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-02-05T08:11:31.156984448",
"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": "0a0f30a8-ac57-4a2c-a6da-2f96a5f27de4",
"name": "string"
},
"created": "2025-02-05T08:11:31.160729318",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-02-05",
"dueDate": "2025-02-05",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "3e6d67c9-0007-4ced-b3ae-30fd780966ba",
"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": "2025-02-05T08:11:31.160817446",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2025-02-05",
"documentId": "bac879d0-73d3-481e-87c9-9b2873c280f5",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2025-02-05",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "36949214-2d26-4726-8e07-f8e37bc76947",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-02-05T08:11:31.160839431",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "da3ca49a-491e-479c-aa35-7503e7b19c2a",
"siteName": "string",
"startDate": "2025-02-05",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2025-02-05T08:11:31.160849222",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-02-05T08:11:31.160866995",
"taxCharges": "decimal",
"taxId": "string",
"totalCharges": "decimal",
"totalChargesUnits": "string",
"totalDocumentCharges": "decimal",
"totalDocumentChargesUnits": "string",
"url": "string",
"utilityCompany": "string"
}