Set-Up
The Vault API requires authentication between STAFFLINK and Vault. Please allow up to two weeks for set up to be performed. Contact your Customer Success Manager to implement this.
If there are multiple Vault accounts, they can all be fed into the same base, or separate bases if that is preferred, each account will need to be authenticated one by one.
Once implemented, please do not change the names of any tables used by the API. Consequently, please also do not change any of the fields that the API feeds data into for each record. If you change data in any of the fields, the API will also overwrite it on the next run.
Not all data is available from Vault, only selected data that is provided by the Vault API.
The following jobs run to syncronise data.
Listings
The listings job feeds listings from Vault. The job runs every hour updating any records that have been modified in Vault since the last run time.
Fields For Listings Table
Vault Data | Field Name | Field Type |
displayAddress | _Address | single line text |
id | _Record_Id | single line text |
saleData.status | _Status | single select |
saleData.portalStatus | _Marketing_Status | single select |
saleData.soldType.name | _Method_Type | single select |
saleData.listingAuthority | _Listing_Date | date |
saleData.conditional | _Contract_Date | date |
saleData.unconditional | _Expected_Unconditional | date |
saleData.settlement | _Expected_Settle_Date | date |
saleData.lifeId | _Life_Id | single line text |
property.bedrooms | _Bedrooms | number |
property.bathrooms | _Bathrooms | number |
property.totalParking | _Parking | number |
Sold price | _Sold_Price | number |
Commission rate % | _Commission_Rate | number |
Fixed commission rate | _Fixed_Commission | number |
Primary agent Id | _Related_Agent_1 | single line text |
Secondary agent Id | _Related_Agent_2 | single line text |
Agents
The listings job feeds listings from Vault. The job runs once a day updating any records that have been modified in Vault since the last run time.
Fields For Listings Table
Vault Data | Field Name | Field Type |
id | _Record_Id | single line text |
Fist name | _First_Name | single line text |
Last name | _Last_Name | single line text |
Email address | _Email | single line text |
Full name | Name | single line text |
Linking Jobs
Linking jobs link data between tables. There are four fields that are involved, two ID fields and two link fields. The API will match records based on the ID fields and link the data using the corresponding link fields for that record. The following links are available, defined by the link between Table A and (->) Table B. Linking threads run every hour.
Listings -> Agents (For Agent 1)
Data | Field Name | Field Type |
Id of Table A | _Record_Id | Text |
Id of Table B | _Related_Agent_1 | Text |
Link in Table A | Agent 1 | Link |
Link in Table B | Listing | Link |
Listings -> Agents (For Agent 2)
Data | Field Name | Field Type |
Id of Table A | _Record_Id | Text |
Id of Table B | _Related_Agent_2 | Text |
Link in Table A | Agent 2 | Link |
Link in Table B | Listing | Link |