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",
"datasourceTypes": [
"string"
],
"endDate": "2025-05-14",
"isTracked": true,
"startDate": "2025-05-14"
}
],
"company": {
"externalId": "string",
"id": "59198eeb-8265-4df2-99c8-9c52a83d0c57",
"name": "string"
},
"country": "string",
"created": "2025-05-14T01:27:07.797619377",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "a0abb074-150d-48b0-9d6d-efb8208b3111",
"status": "string",
"updated": "2025-05-14T01:27:07.797630314",
"url": "string"
}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",
"datasourceTypes": [
"string"
],
"endDate": "2025-05-14",
"isTracked": true,
"startDate": "2025-05-14"
}
],
"company": {
"externalId": "string",
"id": "6cf66392-1ce8-41c7-b66c-bf3c9a93d66e",
"name": "string"
},
"country": "string",
"created": "2025-05-14T01:27:07.798174095",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "05e7113a-8244-4775-a61a-6d378a30c239",
"protectedChanges": [],
"status": "string",
"updated": "2025-05-14T01:27:07.798184843",
"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-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",
"datasourceTypes": [
"string"
],
"endDate": "2025-05-14",
"isTracked": true,
"startDate": "2025-05-14"
}
],
"company": {
"externalId": "string",
"id": "9990df62-be86-432d-a390-d5980ebdd607",
"name": "string"
},
"country": "string",
"created": "2025-05-14T01:27:07.799173887",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "ddc0f97e-f528-4d67-99c9-39078330e0c9",
"protectedChanges": [],
"status": "string",
"updated": "2025-05-14T01:27:07.799186346",
"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": "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",
"chargesUnits": "string",
"company": {
"externalId": "string",
"id": "91f89e75-3d3a-48ee-b6de-acb086a9f1c9",
"name": "string"
},
"created": "2025-05-14T01:27:07.799621088",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-05-14",
"dueDate": "2025-05-14",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "205cf161-caeb-41d5-a78b-a529bee4a32c",
"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-14T01:27:07.799679484",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUnits": "string",
"customContainerUsage": "decimal",
"datasourceType": "string",
"daysInRange": 42,
"documentDate": "2025-05-14",
"documentId": "76664dad-0567-42f2-ba5d-8d2bb2b2211f",
"documentNotes": "string",
"documentSourceType": "string",
"endDate": "2025-05-14",
"exclusion": true,
"icp": "string",
"id": "ae90d9c4-e5f7-4989-9b78-d6265a830040",
"identifiers": [
{
"name": "string",
"value": "string"
}
],
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-05-14T01:27:07.799706630",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "302d3ee7-0752-4cae-8055-8ee53d8a26e0",
"siteName": "string",
"startDate": "2025-05-14",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"totalDocumentCharges": "decimal",
"totalDocumentChargesUnits": "string",
"updated": "2025-05-14T01:27:07.799725531",
"usage": "string",
"usageUnits": "string",
"utilityCompany": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-05-14T01:27:07.799744233",
"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": "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",
"chargesUnits": "string",
"company": {
"externalId": "string",
"id": "cfbff8ec-ba2c-424c-a3f2-e6841c771f52",
"name": "string"
},
"created": "2025-05-14T01:27:07.802586614",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2025-05-14",
"dueDate": "2025-05-14",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "545bd080-233a-419b-9bc8-40266d087292",
"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-14T01:27:07.802664404",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUnits": "string",
"customContainerUsage": "decimal",
"datasourceType": "string",
"daysInRange": 42,
"documentDate": "2025-05-14",
"documentId": "1bd3da23-e3fd-4353-a6f6-742a6f999817",
"documentNotes": "string",
"documentSourceType": "string",
"endDate": "2025-05-14",
"exclusion": true,
"icp": "string",
"id": "885929c9-47df-4ad9-af25-98861d81441d",
"identifiers": [
{
"name": "string",
"value": "string"
}
],
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"podId": "string",
"previousReading": "decimal",
"processedDate": "2025-05-14T01:27:07.802690678",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "b77272cc-5093-428a-bb90-f246d9d2a2f5",
"siteName": "string",
"startDate": "2025-05-14",
"submeterId": "string",
"supplierName": "string",
"tariff": "string",
"totalDocumentCharges": "decimal",
"totalDocumentChargesUnits": "string",
"updated": "2025-05-14T01:27:07.802708631",
"usage": "string",
"usageUnits": "string",
"utilityCompany": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2025-05-14T01:27:07.802727064",
"revisedDocumentId": "string",
"sourceType": "string",
"supersededDocumentIds": [
"string"
],
"taxCharges": "decimal",
"totalCharges": "decimal",
"url": "string",
"utilityCompany": "string"
}