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": "f7ddc539-61ea-4d9e-bd4d-044ebd46a783",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "48823011-53d3-472a-8a50-079cca5f68bf",
"name": "string",
"publicId": "2a9827d3-2ad5-4444-ad45-6ad59e1448e0"
},
"country": "string",
"created": "2024-11-21T08:34:54.947437089",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "95ff062f-effa-408f-81ed-290028ca7f2f",
"status": "string",
"updated": "2024-11-21T08:34:54.947449740",
"url": "string"
}connection.updated
Pushes an event when a utility account connection is updated.
Example
JSON
{
"accounts": [
{
"accountNumber": "string",
"datasourceTypes": [
"string"
],
"site": {
"id": "10d3a32d-edeb-4245-9a60-7fd538e59e22",
"name": "string"
}
}
],
"company": {
"externalId": "string",
"id": "648adb2b-de3b-4e4b-9ec1-14408711a210",
"name": "string",
"publicId": "e3238609-f5a1-48cb-86c6-fedaebecc2e6"
},
"country": "string",
"created": "2024-11-21T08:34:54.947814560",
"datasource": {
"name": "string"
},
"emails": [
"email"
],
"eventType": "string",
"id": "5b2dc47f-9945-4617-b700-619ded444ca1",
"protectedChanges": [],
"status": "string",
"updated": "2024-11-21T08:34:54.947823211",
"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": "aa734507-94f2-44bf-9afb-4157cb48bb63",
"name": "string"
},
"created": "2024-11-21T08:34:54.948586753",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2024-11-21",
"dueDate": "2024-11-21",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "2bf6d1ec-0b35-49ae-a30f-de7ffcce139d",
"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-11-21T08:34:54.948630145",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2024-11-21",
"documentId": "49584bc6-4d2a-4d0f-96d3-1a74f611f218",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2024-11-21",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "9ef7cfc9-8aa2-412a-8932-6bcd89f96272",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"previousReading": "decimal",
"processedDate": "2024-11-21T08:34:54.948649676",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "7ca323bb-0ccd-4d22-af27-9266f098d970",
"siteName": "string",
"startDate": "2024-11-21",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2024-11-21T08:34:54.948658607",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2024-11-21T08:34:54.948671067",
"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": "b2e5b39d-0759-4bfa-a7bf-f18dd8c24dba",
"name": "string"
},
"created": "2024-11-21T08:34:54.951613040",
"credits": "decimal",
"currentCharges": "decimal",
"currentOpenBalance": "decimal",
"documentDate": "2024-11-21",
"dueDate": "2024-11-21",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"eventType": "string",
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"id": "4ab963a3-32b8-4486-8dda-e2a248383bf6",
"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-11-21T08:34:54.951657672",
"credits": "decimal",
"currentCharges": "decimal",
"currentReading": "decimal",
"customContainerName": "string",
"customContainerSize": "decimal",
"customContainerUsage": "decimal",
"daysInRange": 42,
"documentDate": "2024-11-21",
"documentId": "3ecba4ef-a78d-4d65-a224-ee38513db2b1",
"documentNotes": "string",
"electricityDeliveryCharges": "decimal",
"electricityDemandCharges": "decimal",
"electricitySupplyCharges": "decimal",
"endDate": "2024-11-21",
"exclusion": true,
"gasDeliveryCharges": "decimal",
"gasSupplyCharges": "decimal",
"icp": "string",
"id": "9b7bd713-5856-4148-903e-d7222c12e988",
"isEstimated": true,
"isFlagged": true,
"isImplied": true,
"meterId": "string",
"previousReading": "decimal",
"processedDate": "2024-11-21T08:34:54.951676543",
"shopNumber": "string",
"siteAddress": "string",
"siteExternalId": "string",
"siteId": "a0c95ca0-3d89-4c41-9f75-536b2a987e70",
"siteName": "string",
"startDate": "2024-11-21",
"state": "string",
"submeterId": "string",
"supplierName": "string",
"taxCharges": "decimal",
"totalDocumentCharges": "decimal",
"updated": "2024-11-21T08:34:54.951685724",
"usage": "string",
"utilityCompany": "string",
"zipcode": "string"
}
],
"notes": "string",
"previousCloseBalance": "decimal",
"processedDate": "2024-11-21T08:34:54.951698665",
"subTotalCharges": "decimal",
"taxCharges": "decimal",
"taxId": "string",
"totalCharges": "decimal",
"totalChargesUnits": "string",
"totalDocumentCharges": "decimal",
"totalDocumentChargesUnits": "string",
"url": "string",
"utilityCompany": "string"
}