Building Change
Building Change webhook triggers:
- Building created
- Building updated
Summary
The follow table explains the fields
| Field | Description |
|---|---|
| id | Unique identifier for the building record. |
| name | The full name of the building (e.g., "Residential Building (GBP)"). |
| latitude | The latitude coordinate of the building location (nullable if not specified). |
| longitude | The longitude coordinate of the building location (nullable if not specified). |
| shortName | A short or alternative name for the building (nullable if not specified). |
Address Details
| Field | Description |
|---|---|
| address.addressLine1 | The first line of the building's address (e.g., "Demo street 34"). |
| address.addressLine2 | The second line of the building's address (nullable if not specified). |
| address.addressLine3 | The third line of the building's address (nullable if not specified). |
| address.city | The city in which the building is located (e.g., "Munich"). |
| address.postcode | The postcode for the building's address (e.g., "80531231"). |
| address.country | The country of the building's address (e.g., "Germany"). |
| address.isoCountry2 | ISO 3166-1 alpha-2 code of the country (e.g., "DE"). |
Descriptions
| Field | Description |
|---|---|
| houseRules | Rules associated with the building (nullable if not specified). |
| shortDescription | A short description of the building, available in multiple languages (e.g., English, French, German). |
| longDescription | A detailed description of the building, available in multiple languages. |
| directions | Directions to the building, available in multiple languages. |
Custom Fields
| Field | Description |
|---|---|
| customFields.name | The name of the custom field (e.g., "test Ui 1", "idNumber", "building level custom field"). |
| customFields.type | The data type of the custom field (e.g., "TEXT", "DATE"). |
| customFields.value | The value of the custom field (e.g., "test properties id operates correctly", "100", "2022-09-15"). |
| customFields.data | Additional data associated with the custom field (nullable if not specified). |
| customFields.replace | Indicates whether the custom field value should replace existing data (true or false). |
Example
{
"id":2,
"name":"Residential Building (GBP)",
"latitude":null,
"longitude":null,
"shortName":null,
"address":{
"addressLine1":"Demo street 34",
"addressLine2":null,
"addressLine3":null,
"city":"Munich",
"postcode":"80531231",
"country":"Germany",
"isoCountry2":"DE"
},
"houseRules":null,
"shortDescription":[{
"En":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."
},{
"Fr":""
},{
"De":""
}],
"longDescription":[{
"En":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. orem ipsum dolor sit amet, consectetur adipiscing elit."
},{
"Fr":""
},{
"De":""
}],
"directions":[{
"En":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."
},{
"Fr":""
},{
"De":""
}],
"customFields":[{
"name":"test Ui 1",
"type":"TEXT",
"value":"test properties id operates correctly",
"data":null,
"replace":false
},{
"name":"idNumber",
"type":"TEXT",
"value":"100",
"data":null,
"replace":false
},{
"name":"building level custom field",
"type":"DATE",
"value":"2022-09-15",
"data":null,
"replace":false
}]
}
}