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
{
"company": {
"externalId": "string",
"id": "6648674e-c710-424e-812f-3ac82db54948",
"name": "string",
"publicId": "c29b84d4-62dd-4c95-b6d6-c5b08c601997"
},
"country": "string",
"created": "2024-10-17T20:24:45.791315314",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "c858128d-f242-4ab1-9192-0f0cf44e9568",
"sitesRelations": [
{
"accountIds": [
"string"
],
"datasourceTypes": [
"string"
],
"site": {
"id": "3c486dca-bcd2-4711-8ab3-fdbb3e6e8c9c",
"name": "string"
}
}
],
"status": "string",
"updated": "2024-10-17T20:24:45.791341445",
"url": "string"
}connection.updated
Pushes an event when a utility account connection is updated.
Example
JSON
{
"company": {
"externalId": "string",
"id": "d7244bfd-b4d7-40b7-9820-93f4862255e3",
"name": "string",
"publicId": "c7d409c4-dbfd-4499-aee6-5c7a12911b73"
},
"country": "string",
"created": "2024-10-17T20:24:45.791956068",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "8cbf330b-e0f1-4714-964a-f15dfcc03401",
"protectedChanges": [],
"sitesRelations": [
{
"accountIds": [
"string"
],
"datasourceTypes": [
"string"
],
"site": {
"id": "cb6d02ca-0e7b-4d0c-a440-927a009df0c3",
"name": "string"
}
}
],
"status": "string",
"updated": "2024-10-17T20:24:45.791977565",
"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": "2a4a370f-a036-4158-bfe7-146842e66bb1",
"name": "string"
},
"created": "2024-10-17T20:24:45.792883723",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2024-10-17",
"dueDate": "2024-10-17",
"eventType": "string",
"id": "636d3a91-1b52-4b77-820d-c2fe29ecbd84",
"interestCharges": "decimal",
"invoiceId": "string",
"isFlagged": true,
"meterSiteUsageData": [
{
"accountId": "string",
"additionalFields": {},
"auditTrailUrl": "string",
"created": "2024-10-17T20:24:45.792911478",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2024-10-17",
"documentId": "367a6b62-0b26-43e7-93f5-9b0910eca473",
"documentNotes": "string",
"endDate": "2024-10-17",
"exclusion": true,
"icp": "string",
"id": "b072e67e-8e35-493c-9787-2556faaafd80",
"isEstimated": true,
"isImplied": true,
"meterId": "string",
"previousReading": "decimal",
"processedDate": "2024-10-17T20:24:45.792928982",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "c2fe8c79-a6b0-4798-b26c-665c12414ead",
"siteName": "string",
"startDate": "2024-10-17",
"state": "string",
"submeterId": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2024-10-17T20:24:45.792939097",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2024-10-17T20:24:45.792952359",
"subTotalCharges": "decimal",
"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": "1b9346f9-4385-4d15-a0c6-ee5b009b34c4",
"name": "string"
},
"created": "2024-10-17T20:24:45.795515827",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2024-10-17",
"dueDate": "2024-10-17",
"eventType": "string",
"id": "139b4564-9244-46c2-9f04-535f76e7d8c2",
"interestCharges": "decimal",
"invoiceId": "string",
"isFlagged": true,
"meterSiteUsageData": [
{
"accountId": "string",
"additionalFields": {},
"auditTrailUrl": "string",
"created": "2024-10-17T20:24:45.795541636",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2024-10-17",
"documentId": "53aeef66-f79c-4098-a1e9-198c71e6b1ce",
"documentNotes": "string",
"endDate": "2024-10-17",
"exclusion": true,
"icp": "string",
"id": "5506a003-21f3-48f8-8a22-8370ea49d1d3",
"isEstimated": true,
"isImplied": true,
"meterId": "string",
"previousReading": "decimal",
"processedDate": "2024-10-17T20:24:45.795558125",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "1388d291-a5bf-453c-868d-bbde7b8c0eb7",
"siteName": "string",
"startDate": "2024-10-17",
"state": "string",
"submeterId": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2024-10-17T20:24:45.795567554",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2024-10-17T20:24:45.795581685",
"subTotalCharges": "decimal",
"taxCharges": "decimal",
"taxId": "string",
"totalCharges": "decimal",
"totalChargesUnits": "string",
"totalDocumentCharges": "decimal",
"totalDocumentChargesUnits": "string",
"url": "string",
"utilityCompany": "string"
}