{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"multiplyByOccupancy": true,
"eventType": "<string>",
"updated": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"accounts": [],
"url": "<string>",
"initialSites": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"initialDatasourceTypes": [],
"username": "<string>",
"workflowOwnerEmail": "jsmith@example.com",
"dataCollectionStartDate": "2023-12-25",
"isActive": true
}Webhook for utility account connection creation v2
Fires when a new connection is created via the API, magic link, or the platform. The payload contains the full connection state at the time of creation.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"multiplyByOccupancy": true,
"eventType": "<string>",
"updated": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"accounts": [],
"url": "<string>",
"initialSites": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"initialDatasourceTypes": [],
"username": "<string>",
"workflowOwnerEmail": "jsmith@example.com",
"dataCollectionStartDate": "2023-12-25",
"isActive": true
}Body
Webhook payload sent when a new utility account connection is created.
Unique identifier for the utility account connection.
Timestamp when the utility account connection was created.
True when at least one account on this connection has the occupancy override enabled. Occupancy is configured per account (see the accounts array); this connection-level view is retained for backwards compatibility.
Type of event.
Timestamp when the utility account connection was last updated.
External identifier for the connection. Used to associate this connection in Nectar with a connection within your database.
Datasource / utility provider associated with the connection.
Show child attributes
Show child attributes
List of accounts associated with the connection.
Show child attributes
Show child attributes
Company associated with the connection.
Show child attributes
Show child attributes
URL of the utility company's login website.
Observable connection status, read-only to API clients. DEACTIVATED means the connection has been deactivated via isActive=False. COMPANY_INACTIVE means the parent company was deactivated. All other values reflect the most recent scrape outcome. See the connection lifecycle docs for the full enum and what each value means.
PENDING- PendingUNDER_INVESTIGATION- Under InvestigationCONNECTED- ConnectedMFA_TOKEN_EXPIRED- Mfa Token ExpiredPASSWORD_INCORRECT- Password IncorrectNEW_PASSWORD_NEEDED- New Password NeededADDITIONAL_CREDENTIALS_NEEDED- Additional Credentials NeededWEBSITE_DOWN- Website DownNO_ACCOUNTS_FOUND- No Accounts FoundOTHER_ERROR- Other ErrorCOMPANY_INACTIVE- Company InactiveDEACTIVATED- DeactivatedURL_INACCESSIBLE- Url Inaccessible
PENDING, UNDER_INVESTIGATION, CONNECTED, MFA_TOKEN_EXPIRED, PASSWORD_INCORRECT, NEW_PASSWORD_NEEDED, ADDITIONAL_CREDENTIALS_NEEDED, WEBSITE_DOWN, NO_ACCOUNTS_FOUND, OTHER_ERROR, COMPANY_INACTIVE, DEACTIVATED, URL_INACCESSIBLE Country of the utility company.
AF- AfAL- AlDZ- DzAS- AsAD- AdAO- AoAI- AiAQ- AqAG- AgAR- ArAM- AmAW- AwAU- AuAT- AtAZ- AzBS- BsBH- BhBD- BdBB- BbBY- ByBE- BeBZ- BzBJ- BjBM- BmBT- BtBO- BoBQ- BqBA- BaBW- BwBV- BvBR- BrIO- IoBN- BnBG- BgBF- BfBI- BiKH- KhCM- CmCA- CaCV- CvKY- KyCF- CfTD- TdCL- ClCN- CnCX- CxCC- CcCO- CoKM- KmCG- CgCD- CdCK- CkCR- CrHR- HrCU- CuCW- CwCY- CyCZ- CzCI- CiDK- DkDJ- DjDM- DmDO- DoEC- EcEG- EgSV- SvGQ- GqER- ErEE- EeET- EtFK- FkFO- FoFJ- FjFI- FiFR- FrGF- GfPF- PfTF- TfGA- GaGM- GmGE- GeDE- DeGH- GhGI- GiGR- GrGL- GlGD- GdGP- GpGU- GuGT- GtGG- GgGN- GnGW- GwGY- GyHT- HtHM- HmVA- VaHN- HnHK- HkHU- HuIS- IsIN- InID- IdIR- IrIQ- IqIE- IeIM- ImIL- IlIT- ItJM- JmJP- JpJE- JeJO- JoKZ- KzKE- KeKI- KiKP- KpKR- KrKW- KwKG- KgLA- LaLV- LvLB- LbLS- LsLR- LrLY- LyLI- LiLT- LtLU- LuMO- MoMK- MkMG- MgMW- MwMY- MyMV- MvML- MlMT- MtMH- MhMQ- MqMR- MrMU- MuYT- YtMX- MxFM- FmMD- MdMC- McMN- MnME- MeMS- MsMA- MaMZ- MzMM- MmNA- NaNR- NrNP- NpNL- NlNC- NcNZ- NzNI- NiNE- NeNG- NgNU- NuNF- NfMP- MpNO- NoOM- OmPK- PkPW- PwPS- PsPA- PaPG- PgPY- PyPE- PePH- PhPN- PnPL- PlPT- PtPR- PrQA- QaRO- RoRU- RuRW- RwRE- ReBL- BlSH- ShKN- KnLC- LcMF- MfPM- PmVC- VcWS- WsSM- SmST- StSA- SaSN- SnRS- RsSC- ScSL- SlSG- SgSX- SxSK- SkSI- SiSB- SbSO- SoZA- ZaGS- GsSS- SsES- EsLK- LkSD- SdSR- SrSJ- SjSZ- SzSE- SeCH- ChSY- SyTW- TwTJ- TjTZ- TzTH- ThTL- TlTG- TgTK- TkTO- ToTT- TtTN- TnTR- TrTM- TmTC- TcTV- TvUG- UgUA- UaAE- AeGB- GbUS- UsUM- UmUY- UyUZ- UzVU- VuVE- VeVN- VnVG- VgVI- ViWF- WfEH- EhYE- YeZM- ZmZW- ZwAX- Ax
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CW, CY, CZ, CI, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, null Initial sites associated with this connection. Initial sites are often useful to manually associate sites with the connection before the connection is validated or onboarded.
Initial datasource types associated with this workflow. Initial datasource types are used to filter the workflows when the number of datasource types associated via accounts is 0.
11ELECTRICITY- ElectricityGAS- GasWATER- WaterSEWER- SewerDISTRICT- DistrictWASTE- WasteFUEL- FuelMISC- MiscREFRIGERANT- RefrigerantSOLAR- SolarTELECOM- Telecom
ELECTRICITY, GAS, WATER, SEWER, DISTRICT, WASTE, FUEL, MISC, REFRIGERANT, SOLAR, TELECOM Username for the integration workflow.
Utility login / data owner email address. This person will receive notifications if data is missing or if the utility data connection is misconfigured.
Date when data collection for the workflow begins. This is the date from which Nectar will pull historical data. This field overrides the site and company level dataCollectionStartDate fields.
Whether this connection is actively collecting data. When set to False, the connection stops collecting new data but all historical data is preserved, and the status field will reflect as DEACTIVATED. Set to True to reactivate data collection. This is the preferred way to deactivate a connection instead of deleting it.
Response
No response body