What’s New
We are constantly working to improve your experience with the Public APIs. Have a look to see what new features and fixes have been released.
Last updated
We are constantly working to improve your experience with the Public APIs. Have a look to see what new features and fixes have been released.
Last updated
Utilities
You can now retrieve (GET) and update (PATCH) the type ‘other’ for the following utilities for the endpoint ‘/properties/{id}/utilities’:
Water
Electrical
Sewerage
Heating
Broadband
Parking
Accessibility, Rights & Restrictions and Flood & Erosion Risk
The above additional information is now surfaced on the 'GET /properties' & 'GET /properties/{id}' endpoints:
Property Checks
Default property checks are now returned via '/properties/{id}/checks':
Sub Agent Fee
Sub Agent fee information is now returned on 'GET /properties' and 'GET /properties/{id}' under ‘subAgentTerms’:
Sales Progressor
A new sub resource on the properties endpoint ‘GET /properties/{id}/negotiators’ has been added to support surfacing a sales progressor attached to a property (type : salesprogressor):
Withdrawn Reason
The reason when a property is made ‘Withdrawn’, is now available via the properties endpoint under 'reason':
Modern Method of Auction (MMoA)
The new disposal type (modernMethodOfAuction) added to the Reapit CRM, is now surfaced in the properties payload:
Gross Yield and Estimated Monthly Rental Value
Both the Gross Yield ‘grossYieldPercentage’ & Est Monthly Rental Value ‘estimatedMonthlyRetailValue’ are now available in the Properties payload:
Keywords
We now support POST\PATCH for property keywords:
Note: This should be used in conjunction with 'GET /departments' configuration endpoint.
Property Checklist
A new sub resource' GET /properties/{id}/checklists' has been added under the Properties endpoint to support customisable property checklists:
New endpoint
We have introduced a new endpoint to support retrieving certificates without needing to specify a property ID:
Note: This should be used in conjunction with the new Configuration endpoint 'GET /configuration/certificateTypes’.
Status ID
It is now possible to POST\PATCH the ‘statusId’ for a certificate:
Note: This should be used in conjunction with the new configuration endpoint 'GET /configuration/certificateTypes/{typeId}/statuses’
Additional Descriptions Fields
If additional subscription fields are added via the Marketing screen in the Reapit CRM, they are now returned via the 'GET /Properties/{id}/marketing endpoint':
A new sub resource on Properties to support GET/POST /PATCH for ‘Alarms’:
Note: This should be used in conjunction with the new configuration endpoints to support alarms:
You can now identify staff members that are full contacts via the links collection on the 'GET /companies/{id}/staffMembers' endpoint:
Identifying the main staff member
In the Reapit CRM, you can set a staff member as the main contact. This is now reflected in the payload via ‘isMainContact’ set as true:
Contact Categories
It is now easier to identify the parent group of a contact category, as we have introduced a new field ‘value’ under the ‘GET /configuration/contactCategories’:
The 'currency' value is now surfaced on a tenancy (previously was only available on the Properties, Applicants or Offer endpoints):
Inspection Frequency
Initial Inspection Frequency (initialInspectionFrequencyInDays) & Inspection Frequency (regularInspectionFrequencyInDays) are now available via the Tenancies endpoint:
Preferences
A Landlords ‘Send Statement’ preference is now available via 'GET /landlords/{id}':
Negotiator ID
You can now retrieve, create and update (GET/POST/PATCH) a ‘negotiatorId’ to the Enquires endpoint to associate a specific negotiator:
New parameter
You can now run a partial (like) search/filter based on the ‘text’ field:
New endpoint ‘GET /journalEntries/landlords’ to support specific journal entries for landlords, with the following query parameters:
pageSize/pageNumber
landlordId
propertyId
negotiatorId
type
createdFrom/createdTo
Note: Your app/integration will need the ‘Read journal entries’ permission/scope to interact with this endpoint.
We have updated the applicants endpoint to support setting an archived record as ‘active’. This is the only change that can occur to archived data on the applicants endpoint:
‘No Internet Advertising’ is now available on the PROPERTIES view as ‘INTERNET_ADVERTISING’:
A new field to support recording if deposit schemes are accepted on a lettings property. ‘depositSchemeAccepted’ has been added to the properties endpoint:
Note: The field is only available in the Reapit CRM from versions 12.182 +
We now expose the occupy date (occupyOn) and vacate date (vacateOn) on a tenancy.
Within the property payload you can retrieve information relating to available services:
The list of services is configurable in the system and differs between customer systems. As such, the new GET /configuration/propertyServiceTypes endpoint should be used to when interpreting this data.
Occupier information relating to a lettings property is now available within the links collection:
Sub Agent Terms are now available on the properties under the selling model:
A new string ‘marketingconsent’ has been added to:
Applicants
Vendors
Tenancies
Landlords
Offers
New ' PROPERTY_SALES_CERTIFICATES' view:
Added a new View ‘‘TENANCY_STATUS_CHANGES’. Similar to the view ‘PROPERTY_STATUS_CHANGES’, we have created a view to surface: TA (Tenancy Arranging), TC (Tenancy Current), TX (Tenancy Cancelled), TF (Tenancy Finished):
Within the Analytics schema we are now surfacing ‘Management Period’ information in the Properties View:
The ‘ONE_OFF_FEE_NARRATIVE’ column has been added to the TENANCY_ALTERATIONS view:
New fields ‘LETTINGS_RENT_COLLECTION_PERCENTAGE’ and ‘LETTINGS_RENT_COLLECTION_AMOUNT’ have been added to the PROPERTIES view:
Added a new ‘EXCHANGE_DUE’ field to the OFFERS view:
‘HAS_RENT_INSURANCE’ has been added to the tenancies view and we have also created a new ‘PROPERTY_LETTINGS_RENT_INSURANCE’ view:
• ID • POLICY_START_DATE • POLICY_END_DATE • PREMIUM_AMOUNT (take into account config) • PREMIUM_PERCENTAGE (take into account config) • AUTO_RENEWS (Yes/No) • _CUSTOMER_ID • _LAST_SYNCH_AT
Added a new ‘APPLICANT_LOCATION_REQUIREMENTS’ view:
Added a new ‘REQUIRED_BY_DATE’ column to ‘TENANCY_CHECKS’ view:
Discover our latest comprehensive release notes for the Reapit CRM, detailing new features and enhancements to our desktop application here.
Subplot identification is now available via the properties API under 'developmentSiteType' and extended to webhooks for properties 'created' & 'modified':
A new sub resource on the property images endpoint (POST propertyImages/reindex) to support image reordering:
‘Other Agent Appraisals’ information for GET, POST & PATCH is now available and can be located as a sub resource on the properties endpoint:
GET properties/{id}/appraisals
GET properties/{id}/appraisals/{appraisalId}
POST properties/{id}/appraisals
PATCH properties/{id}/appraisals/{appraisalId}
A new query string parameter has been added to the offices endpoint to support ‘Region’ filtering:
A negotiator's profile image (PROFILE_IMAGE_URL) has been added to the NEGOTIATORS view:
We have also added alternate/old codes to the PROPERTIES view, which can provide a means of identifying properties either by giving them an alternate reference number that is more meaningful, or being able to locate properties by an old system code when a customer has migrated to a Reapit product.
We now surface the following communication preferences (read and write) for companies:
Email, Letter, Phone & SMS
Deprecation Notice: On 1st September 2024 we will be retiring the legacy webhook signing mechanism in favour of the now more widely adopted cryptographic signing method.
You only need to take action if you are currently reading and validating the Reapit-Webhook-Signature header that is included with all webhook events. You will need to update your webhook handler to switch over to using the X-Signature header instead, using the method outlined in the developer documentation here, which includes code samples for both Node and .NET.
If you are not currently validating the sender of the webhook event, it is highly recommended that you introduce this important security feature and implement validation of the X-Signature header to protect your own systems.
If you require any assistance updating your application, please reach out to us on Github where we will respond in line with our development processes.
Discover our latest comprehensive release notes for the Reapit CRM, detailing new features and enhancements to our desktop application here.
A new 'managerId' (Tenancy Manager) field has been added to the TenancyModel:
A new POST referrals endpoint has been added to allow the creation of referrals via the Platform. Customers using the Marketplace Management app will have the option of restricting which referral types an app or integration has access to:
Appointments in Reapit now provide an ‘Attendance’ option. This has been added to the Appointments API in the Platform under ‘attended’:
A new ‘reserveAmount’ field has been added to the WorksOrder payloads that maps to the ‘main float’ in Reapit. The main float is the amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item. For full validation and behaviour rules, please review the following ticket: https://github.com/reapit/foundations/issues/8758:
References and Guarantors
It is now possible to retrieve a guarantor's 'id', 'guarantorAssociatedId', 'type' & 'referenceStatus' from the tenancies/{id}/relationships endpoint:
Above is an example of a single guarantor associated to a tenant in AgencyCloud.
Using the tenancy ID and calling the GET tenancies/{id}/relationships endpoint, it will return the following in the ‘guarantors’ object:
Multiple guarantors will be displayed as below:
References:
Below is an example of a single contact added as a reference to a tenant in AgencyCloud:
Using the tenancy ID and calling the GET tenancies/[id}/relationships endpoint, it will return an 'id', ‘referenceAssociatedId’, ‘type’, ‘referenceStatus’ & ‘referenceType’ in the ‘references’ object:
We have added a new sub resource to our Properties endpoint to obtain Property Certificates without the need to specify a Property Reference (ID):
In addition to this and to support the 'Certificate Management' functionality in AgencyCloud (desktop CRM), an endpoint to understand the certificate responsibility (GET /properties/{id}/certificates/responsibilities):
Two new filters added to the Appointments endpoint, ‘followUpFrom' and 'followUpTo’:
Related ticket: https://github.com/reapit/foundations/issues/10018
‘paymentPlan’ is now surfaced under the Tenancies endpoint:
Related ticket: https://github.com/reapit/foundations/issues/9909
We are now returning the Business number in the negotiators endpoint under the 'additionalContactDetails' object:
Related ticket: https://github.com/reapit/foundations/issues/9792
You can now filter the Landlords endpoint by associated officeID:
Related ticket: https://github.com/reapit/foundations/issues/9791
Visibility of the ‘status’ is now presented on a property certificates with an associated up to our configurations endpoint (/configurations/certificateTypes):
Related ticket: https://github.com/reapit/foundations/issues/9126
We have released an update to our webhooks package to support app authentication rotation
Related ticket: https://github.com/reapit/foundations/issues/9915
Revised support on the enquires endpoint for office groups (customers using the Marketplace Management App)
Related ticket: https://github.com/reapit/foundations/issues/10076
We are now returning a more meaningful error when the physical file does not exist
Related ticket: https://github.com/reapit/foundations/issues/10005
You can now POST the ‘breakFrom’ and ‘noticeRequired’ fields in the 'tenancies/{id}/breakClauses endpoint':
We are now automatically posting a journal entry using a new Journalisation package when the following occurs:
When a new property is registered:
When a new applicant is registered:
When a new contact is registered:
When we detect a change to the contact consent flag:
Two new fields have been added to the EPC model to expose the ‘First Page URL’ (firstPageDocumentUrl) and ‘Full Document URL’ (fullDocumentUrl):
The latitude and longitude are now populated under ‘geolocation’ for offices in the Offices API:
We have added a new view ‘PROPERTY_STATUS_CHANGES’, to the Analytics Schema to expose a simple view of property status changes. The new view includes the following fields:
ID
PROPERTY_ID
PROPERTY_CODE
OLD_STATUS
NEW_STATUS
CHANGED_AT
_CUSTOMER_ID
_LAST_SYNCH_AT
Property Manager field in AgencyCloud is now exposed under '‘LETTINGS_PRIMARY_PROPERTY_MANAGER_NEGOTIATOR_I’ in the Analytics Schema.
We have extended both the POST and PATCH tenancies endpoint to support Letting Fee (lettingFee) and Management Fees (managementFee):
Next Call (nextCall) and Last Call (lastCall) are now exposed in the properties API:
A new endpoint has been added to support updating existing enquiries:
If enabled, Rental Insurance information is now available under the ‘PropertyLettingModel’:
This also includes a new configuration endpoint to surface Cancellation Reasons:
Property Licensing Data is now available on the properties endpoint, displayed under the ‘PropertyLettingModel’:
In addition to this, we have added a new documentation type ‘LIC/Licensing’ to the document type configuration endpoint:
You now have the ability to embed ‘relationships’ via the companies endpoint:
We now support tenancy renewal options (Tenancy Agreement Clauses) in the Tenancies API:
This also includes 2 new configuration endpoints to support the tenancy renewal options and renewal optional conditions:
In addition, we have also included a ‘lettertext’ field in the TenancyAllowanceModel (/tenancies/{id}/allowances endpoint) & the TenancyResponsibilityModel (/tenancies/{id}/responsibilities):
3 new fields have been added under the Tenancy Break Clauses endpoint (/tenancies/{id}/breakClauses) to surface Break From (breakFrom), Required Notice (noticeRequired) and Letter Text (letterText):
It is now possible to set the default window size of your app when it launches in AgencyCloud. Currently, all apps are launched based on the default configuration set by the customer. The standard configuration is set as Width 950 x Height 700.
Within the ‘AgencyCloud Integration’ section on your app, you will be able to adjust the size in which your app is presented in AgencyCloud:
Please note that only apps with a desktop integration type can modify the app size. If you do not have a desktop integration type, you will not be able to edit the default sizes.
Floor Level (floorLevel), Property Internal Floors (internalFloors) & Total Building Floors (totalFloors) are now available both read and write:
We have added the field ‘checkTypeId’ to the POST /tenancies/{ID}/checks endpoint:
It is now possible to view more information about an office group installation through the DeveloperPortal.
If your app is installed by an office group, you will receive an email and a webhook (if configured) with the customer ID, for example XXX-XXXX. The first 3 characters represent the organisation, the remaining 4 characters represent the office group ID. For more information on office groups please visit: https://foundations-documentation.reapit.cloud/faqs#what-are-office-groups
To see which offices are within that group, open your app in the developer portal and navigate to ‘Installations’:
This will display all active installations for your app. If you have an office group installation, for example RES-GRTA:
You will have the option under the dropdown menu to ‘Show installed offices’:
This will provide you the name of the office group ‘Office Name’ and the office ID’s that form that group. From the example above, only office ‘BCK’ is in the office group ‘Market Town’.
To retrieve further information about an office, you can use the ‘ID’ in conjunction with the ‘Offices’ endpoint.
Related services: Applicants, Landlords, Tenancies, Offers & Vendors
AgencyCloud provides the option of a free text field to record additional contact information, such as ‘Wife’s Mobile’ in addition to the core fields such as Mobile, Home & E-mail.
By default, we will now return those additional contact details under the ‘additionalContactDetails’ array on the above related services.
The ‘Details/Notes’ field is now available on a tenancy under ‘feeNotes’:
A new POST /bulk endpoint has been added to allow a creation of multiple journal entries:
We have added a new configuration endpoint ‘terminology’ to help developers understand customer specific terminology.
For example, some customers prefer to use 'Sold STC' instead of 'Under Offer' or 'Market Appraisal' instead of 'Valuation'.
Using the new configuration endpoint, this will make it easier to understand for each customer. Please see example for our Sandbox configuration:
It is now possible to filter by ‘Active’ status and by ‘OfficeIDs’ on the /preTenancyCheckTypes and /renewalCheckTypes configuration endpoints:
It is now possible to both read and write to the ‘Repeat’ field on appointments:
By default, the property payload will now return the name of the local authority ‘localAuthorityCompanyName’. Previously, it only returned the ID:
Added Authentication Security: By default, the ‘Authentication Client Secret’ will now be hidden and only accessible by an ‘Admin’:
Non Admin users will see the following:
As an Admin, you can check or change the role of a user within your organisation by simply navigating to the ‘Members’ area.
We now support the option for 'Four Weekly' rent frequency on Applicants:
Agreement signed is now available under the Property Letting Model:
Other Agent information has now been added to appointments otherAgent with the otheragentId available in the _links collection
The list of allowed journal entry types has been expanded to now include ON (offerNote):
Two new filters have been applied to the Applicants endpoint to allow filtering by ‘Last Call’ (hasLastCall) and ‘Next Call’ (hasNextCall):
We have added additional information on the ‘preTenancyCheckTypes’ configuration endpoint to surface if a check is ‘active or inactive’ and which offices the check applies to e.g. OXF, MKN:
Management Fee information (percentage & amount) is now available in the Analytics Schema under the Tenancy Renewal table:
The Developer Edition has been upgraded to 12.160 which now includes a new desktop integration type of ‘Renewal Negotiation Check’
‘Renewal Negotiation Check’ can be given to an application that will replace the checks section on a Renewal Negotiation screen in AgencyCloud.
For more information on this desktop integration type, please visit.
Also coming soon, the ability to launch apps from the images section in AgencyCloud.
The property images endpoint now respects the maximum dimensions that are set in a customer's configuration.
When a tenancy is in an arranging status, we now expose the contacts associated to the attached applicant in the related collection.
Company information is now returned on a contact under the company link.
Converted room dimensions are now returned on a property under ‘dimensionsAlt’.
Release 4.0.0
New Features
Visual Language has been revamped with detailed rules for icons, fresh new icons and improved styling for better visual consistency.
Iconography (Visual Language section) has been reorganised into new categories.
Product Brand Imagery (Visual Language section): a full set of illustrations was added to the collection.
Mobile navigation has been added to UI Elements
Bug Fixes
Reapit and ReapitConnect logo sizes have been adjusted
ReapitConnect logo is now a vectorial image
One Choice Chips (Segmented Control) has been renamed to Toggle Button. Its width size changed from static to dynamic.
Desktop - Full Options Expansion Panel style has been changed (shadow and outline)
Custom applicant attributes that are usually captured on the requirements screen under ‘Must Have’ or ‘Special/Special Requirements’, are now surfaced for applicants under ‘specialFeatures’:
The ‘Renting Position’ is now surfaced on an applicant under ‘renting.positionId’:
Note: The renting position list is configurable and can be cross referenced against a new sub-resource under the Configuration endpoint ‘GET /configuration/rentingPositions’.
You can now create pending supplier invoices using the new sub-resource under the Transactions endpoint ‘POST /transactions/supplierInvoices’:
For the full specification, validation, and behaviours, please review ticket https://github.com/reapit/foundations/issues/7764 in conjunction with the swagger documentation.
‘Tenancy Alterations’ data is now included in the Analytics Schema:
It is now possible to set an applicant as a Potential Client (potentialClient):
We are now surfacing remaining lease (leaseRemaining) information on Applicants:
'Pre Instruction Checks' data is now included in the Analytics Schema:
We now support the option to POST to the Journals endpoint the following letter types:
Arrears Letter (AL), Notice to Quit Letter (NQ), Tenancy Renewal Letter (TR), Letter Sent (LE)
Please note: In the case of AL/NQ/TR the associated type MUST be ‘tenancy’.
The ‘Text’ field (urlcaption) is now both read and write:
'Referral' data is now available within the Analytics Schema:
It is now possible to update the ‘marketingConsent’ field on an archived contact record:
Please note: Only the Marketing Consent field on an archived record can be updated.
As you may have already seen, on Wednesday 26th, we launched the latest version of the AppMarket. The updated AppMarket includes and now supports, app name & developer searching, new categories and filter options plus featured apps and app collections:
Part of the redesign will now allow customers on Rackspace, to view apps that were previously hidden due to the compatibility with AWS. Whilst they still will not be able to install or enable integrations that use data Webhooks, they will now be able to enquire about the app/integration, view the marketing materials and videos.
The new AppMarket now also includes the ability for Developers to add videos to their app listings. ‘Getting Started’ & a ‘Why’ video. For information on how to add a video to your app listing, please click here.
Applicant Tenure information is now available in the Applicants ‘Buying’ modal:
We now support filtering on the Companies endpoint by Office Groups.
For more information on office groups, please visit https://foundations-documentation.reapit.cloud/faqs#what-are-office-groups
‘Allowances’ can now be created and updated:
‘Break Clauses’ can also be created and updated:
And also for ‘Responsibilities’:
It is now possible to patch nested objects in the Metadata API
We have exposed the ValuationDate & AgreementExpiry dates under the property selling model
Videos
Applistings now support the ability to add video URL's. Under the section 'AppMarket Listing', you'll see 2 new fields:
The video's will then be rendered in the AppMarket:
Please note: We recommend strongly that if you do upload videos, to use the online streaming site YouTube.
App Deletion
To prevent accidental data loss, we have added an additional layer of protection for apps. On each app, under the section ‘AppMarket Listing’, you will now see the following check box:
If you should then accidentally select ‘Delete’, you’ll be prompted the following message and will need to disable the additional protection before you can delete the app:
Please Note: The app data protection check box is not selected by default so, to ensure your apps and its associated data are protected, please review your app listing.
Unmapped attributes:
Property and Applicant attributes/requirements (department data) is completely customisable for each agent and subsequently it can be difficult to understand how to interpret this data as it comes out of the various APIs that expose it.
As the Platform APIs are standardised across all our customers, Department data has also been standardised where possible using a mapping mechanism to map the customisable values from our CRM into standard values in the API.
Any options that do not have a corresponding mapping and are selected on a Property or Applicant entity will be included in the unmappedAttributes and unmappedRequirements collections in their respective APIs. Additionally, the Special attributes column in the CRM is mapped explicitly.
Example payload:
Fields:
To view the latest version of the mappings, please visit: https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data
The Properties API now displays the Maximum Reception/Bathroom ranges:
It is now possible to create a Works Orders journal entry:
Note: TypeID must be set to 'WO' when passing worksOrder
We now support filtering on the Companies endpoint by Negotiator and Office:
Applicant ReasonID and SellingPosition now available using POST and PATCH methods:
New ‘Diary’ desktop integration type now available from version 12.152.3. App’s that have selected ‘Dairy’ as the integration type will be launched from an existing appointment. For more information, please click here.
It is now possible to read deposit and deposit holder information via the tenancies API. This information can also be written back up to a certain status:
It is now possible to filter tenancy checks by type:
Market Appraisal (valuation) price now available:
Pre-Instruction checks can now be managed via /properties/{id}/checks:
It is now possible to find applicants by phone number (and any other contact detail):
Webhook transactions can now be filtered much more granularly to allow you to find transactions more easily (Topic name, Entity ID & Event ID):
The validation has been updated to more closely match the contacts API
The Referrals API has now been enhanced to support updating (PATCH) and the ability to store metadata:
It is now possible to see the Id’s of disabled portals set against a property:
You can now filter properties by AreaId:
Our multi currency support milestone has been completed. It will be most beneficial for UK customers that advertise international properties. For more information, please review our milestone here.
When creating a new enquiry (which is visible on the Internet Registration panel in AgencyCloud) you can now pass price/bedroom requirements for sales and lettings applicant enquiries:
We have added support to allow retrieval of ‘tenancy’ journal entries.
Rural property data is now exposed with certain fields writeable under the ‘rural’ section on a property:
Lettings management fees, type and amount now available under the ‘managementFee’ section:
Number of units (numberOfUnits) in a development now available:
Minimum tenancy term (minimumTerm) now available for lettings properties:
‘smallHolding’, ‘estate’ & ‘developmentOpportunity’ property types are now available via the Properties, Departments & Applicants endpoints. Please note, the additional types are only available in some customer's systems. The 'Departments' endpoint should be used to understand the configuration of a specific customer.
Contact categories can now be retrieved using the ‘Configuration’ endpoint ‘contactCategories/{id} and can also be set on a ‘Contact’:
Public brochure URLs (publicBrochureUrl) are now available in the Properties API under either the ‘Selling’ or ‘Letting’ object:
A works order note (worksOrderNote) can now be added at the property level which will cascade down to any works order for that property in Agency Cloud:
Office status can now be obtained from the Offices API so you can understand whether an office is open or closed based on the field type ‘active’:
Last week, we released the first phase of the ‘Referrals’ endpoint which includes the following:
The second phase will include the ability to write to the endpoint, metadata & associated webhooks. You can track the phase 2 milestone here
Journal Entries: You can now store a journal entry of Match (MA) against a property or applicant record Bedroom Range: The ‘Max’ bedroom range is now exposed in the Properties API – this is most useful for marketing of property developments. Properties: We have added support for Juliette Balcony (property situation), Studio (property style) and Villa (property type). Companies: Additional contact information is now available for companies. The additional information is available in ‘additionalContactDetails' object:
Transactions: It is now possible to filter transactions by ‘Outstanding’ amount.
The latest release of the Developer Portal (v3.0.5) included the re design of the following pages… Settings: We have updated the UI within the settings section in accordance with our design system and the other pages within the portal. The options available to you when accessing settings will be dependent on your user level:
Admins of an organisation can set the level of users (members) on the ‘Members’ page. Analytics: We have separated the features and information available to you in specific sections: ‘API Usage’, ‘Costs’ & ‘Installations’.
You can use the filters on the left-hand side to set the data results for each page.
In the latest release of our Design System Figma file, we introduced new button states and a new component. We have also fixed a few bugs and revised/added additional documentation for buttons. New Features
Disable and hover states for desktop buttons
Disable state for mobile buttons
New medium size infographic icon (Manage App Listing)
File Upload component
Measurements: misspelling on the red static button; it was 38px, now it’s 40px
Measurements: misspelling on the ‘One Choice Chips’ component - active state, selected chip, padding was 4px and now it’s 3x, margins were 3px and now it’s 4px
Documentation about button types was added to all components that use them
Static button with icon has been documented
Static button width size for mobile has been increased to 120px
Guidelines for static and dynamic buttons have been revised
Desktop - Full Options Expansion Panel: button margins and distance between buttons and content have been revised
We are pleased to confirm, the Properties API has been updated to provide the following information ahead of the Material Information requirement by the end of May 2022. Related information here.
The following fields are available:
Council Tax Band (councilTax)
Local Authority (localAuthorityCompanyId)
Ground rent for leasehold properties (groundRent & groundRentComment)
Maintenance charges for leasehold properties (serviceCharge & serviceChargeComment)
Leasehold length (tenure.expiry)
Last week, we updated our Webhook functionality to increase throughput and to reduce latency. We have seen a significant improvement already. We have enhanced the way in which we process webhook events. Nothing has changed for you in how you create or manage your webhooks but the background service has been re developed to better increase the rate in which they are emitted.
Deposit Data (Type & Amount) is now available inside the Lettings object on Properties API under ‘deposit’:
Properties by Negotiator ID(s)
Properties by Country ID:
To better help us identify the company you are associated to and help with triaging tickets that are raised via GitHub, you can now save your GitHub username on your ‘Profile’ page in the DeveloperPortal:
The 'Help' page is moving into our main documentation. The 'Help' icon on the main navigation will soon no longer be visible but you can still access help by going to 'Docs > Help'.
This week, we have released a new version of the Developer Portal, specifically an updated version of the app creation flow and app edit pages.
The new design has been developed to improve the UI (now using Elements V3) and to improve the user experience. We’ve also added a very helpful new feature. Read below to find out more.
To better help you navigate the app creation process, we have included a helpful app creation wizard. The wizard is designed to make creating an app as straightforward as possible by preselecting/populating certain fields based on your use case.
You can select the type of integration from the list below:
Or if none of the above suit your requirements, simply scroll down and select either a Client-side app or Server-side Integration:
With every selection, we will present the associated documentation on the right-hand side to help you with the process.
You’ll find helpful links for more information or on certain selections, a short video.
When you have completed the wizard, you’ll be directed to the ‘App Details’ page. This page will contain all the information you need to get started developing right away, such as the Client ID and or Client Secret:
The app name will be pre-populated based on your company name. You can change this at any stage.
To edit your app, simply click ‘Edit App’ from the left-hand navigation.
Depending on what type of app you have selected from the wizard, you’ll be presented with various tabs. The first tab for all types is the ‘About Listings’.
On the ‘Edit App’ page is where we have introduced a new feature ‘Check Status’.
The check status button is a very quick and easy way to see the current status of your app, what information is missing, your AppMarket status and to see if have any changes that require saving.
The process for submitting your app for review is the same as before. Simply check the status of your app and once all checks have been completed (see example below):
A button on the left-hand side will appear ‘Submit Review’. This will create a revision to our Admin team.
Once your app has been approved (please click here for more information on the reviewal process) the button will change to present the option to ‘Delist’ your app.
The additional tabs, as mentioned previously, will depend on your app type but in all cases, you will have an ‘AppMarket Listing’ and a ‘Permissions’ tab.
The ‘AppMarket Listing’ tab captures the app listing content for the AppMarket and will need to be completed before submitting your app. Images, description, contact information etc.
The ‘Permissions’ tab will relate to the endpoints and data sets you wish to interact with and the visibility of your app (either public or private).
For other types of integrations, you will see the tabs for AgencyCloud Integration and Authentication.
We will be continuing to update the Developer Portal in the coming months to further enhance the user experience and features available to you.
You can now interact and launch with the native works orders screen and pre populate certain search criteria using the newly added AgencyCloud scheme:
For more information on Works Orders, please click here
The category of Match Output would enable an application to be used to export the details of a match either from an applicant to a property or a property to an applicant.
An app with the integration type 'Match Output' will be visible by selecting 'Print' after running a match:
For more information on Match Output, please click here
We are now returning (when manually entered) the Property URL, which is accessible from the 'Marketing' screen:
Please note: The URL will only be returned when it has been explicitly set. Default URLs' will not be available.
The featured property image (featuredImageUrl) is now being returned in the properties object, without the need to embed or make an additional call to the property images endpoint. This will be mostly beneficial for website integrations for property results.
We are now returning the Property Manager ID (propertyManagerId) within the lettings object on a property.
We have now added the ability for users to request additional extras fields for Works Orders and Landlords.
Also, you can now filter by ‘QuoteAccepted’ on Works Orders.
We have now updated our code generation mechanism to now support office specific referencing.
We have recently updated our Development Request documentation to now include a FAQ’s section. Part of the update to the documentation includes a detailed description on each label, column and board. Please take the time to review the updated documentation and ensure you understand how feature requests and bugs are triaged via the Platform. In addition to the updated documentation, we will shortly be implementing a ‘GitBot’. The GitBot is designed to auto reply to specific issues raised, when issues are moved to certain columns, assigned specific project boards or certain labels added. Essentially, an automated comment to will be added to the issue which will help explain the reason a specific label was added, why it was moved to a certain column and the time frame in which we expect the work to be completed by. The automated email will be sent the person that raised the issue or anyone that has subscribed. If you would like to receive a notification (email) to an issue you are following but have not raised, please make sure you are subscribed, using the ‘Subscribe’ option from the right-hand navigation. Please do not contact our service desk, customer success managers or any other channels within Reapit with regard to the status or timeline of an issue. Please first refer to the documentation and communicate with developers directly in GitHub.
We have introduced a new section in our documentation ‘Troubleshooting’.
The documentation is intended to provide guidance to our Developers when building apps and integrations through the Developer Portal.
Currently, it offers support on the following topics:
Accessing Customer Data Authentication Issues Installation REST API Reapit Connect
We will continue to add and update this section but don’t forget, we also have a dedicated page for FAQ's, which can be found here.
Remember, if you are having an issue not covered in the documentation or you have discovered a bug, please raise an issue on our public board by clicking here.
The email address you entered when registering for the Developer Portal, is used by default to receive email notifications,. For example, when your app is installed from the AppMarket, you will receive an email with the details (see more information here)
As you cannot change the email address that registered your organisation, we have now provided the ability to supply an alternative ‘Notifications Email’.
If you want to setup an alternative email address, simply go to ‘Organisation’ page.
Please note: Only an Admin will have the correct permissions to update this information.
We are pleased to announce have added new endpoints to the Properties endpoint to now allow for reading and writing of ‘Certificates’.
In conjunction with the new entities, we have also added to our Configuration endpoint, the ability to surface CertificateTypes.
We have now included a ‘Transactions Logs’ section on the ‘Webhooks’ page, to allow you to filter your transactional Webhook history by date and app. To view your webhook transaction logs, simply navigate to the ‘Webhooks’ page inside of the Developer Portal, select a date range (will default to the last 7 days) and select an app:
From each log item, you will be able to see the URL, the selected topic, status and the option to ‘Download’.
Selecting ‘Download’ will save a copy of the specific payload as a JSON file.
We have added the following new Webhook topics: appointments.cancelled appointments.confirmed contacts.optedout enquiries.accepted enquiries.rejected offers.rejected offers.withdrawn offers.accepted properties.selling.askingpricechanged properties.selling.completed properties.selling.exchanged properties.selling.withdrawn properties.selling.instructed properties.selling.lostinstruction properties.selling.underoffer worksorders.cancelled worksorders.complete worksorders.raised If you wish to setup subscriptions to any of the new the topics listed above, you will need to have selected the associated scopes. For more information on the required scopes, please visit the associated documentation here.
We have introduced a new REST Hooks Endpoint. This functionality allows you to programmatically set up webhook notifications for your application rather than needing to do this manually using the ‘Webhooks’ page in the developer portal which can help you automate onboarding of customers.
We continue to develop new features and products on the Foundations Platform and have updated our Terms and Conditions to reflect these changes. From 25th June, when you next login to the Developer Portal, you will be presented with the latest updated terms and will need to accept before continuing to use the Developer Portal. Our current and revised terms can be accessed through the Developer Portal documentation under ‘Developer Terms and Conditions’.
Our desktop integration types have been extended to now include the following communication types included in AgencyCloud from version 12.130.1 :
Outbound – Email
Outbound – Landline
Outbound – Mobile
On each communication type, the Desktop API will provide a 'cntCode' and relevant communication information, either email, landline number or mobile number.
App that’s have any of the above desktop integration types will be visible in AgencyCloud when right clicking on the relevant icon, please see example below:
The Developer Edition of AgencyCloud has automatically been updated to include the new communication types.
It is now possible to set or clear default property brochures when updating existing properties, using the PATCH method on /properties/{id}
To ensure data viability and security, we have made a change to the way 'Sandbox only' Webhooks are handled.
Webhooks that have been setup specifically for Sandbox testing (SBOX) and have been unmodified for 14 days, will automatically be deactivated.
We have added additional support for uploading files over 6MB (Up to 30MB) to the Property Images and Documents endpoints via the use of pre-signed URL's
We are excited to announce today, the Developer Portal, Reapit AppMarket and AppMarket Apps UI have been updated in conjunction with the release of our Elements UI library version 2. The functionality of all apps remain the same but with UI enhancements to your user experience.
The visual changes you see are the first step towards a universal design language we have been working over the first part of the year. In the coming months you will see continued incremental updates as pages and flows are re-worked for better UI consistency, polish and UX. In keeping with our open source commitment, in the coming months we plan to make available publicly the design language, sample layouts and designs so that Reapit Developers can leverage our design resource to build better user experience into their own AppMarket apps.
Because we ask that all AppMarket Apps use our UI for visual consistency, we wanted to give the style guide a lift to ensure it best showcases of our development partner's work. This is the core of the Elements v2 release - it is a subtle evolution of the library, including a new font, typography, colour pallet, form inputs, notifications, dialogue boxes and much more.
Care has been taken to avoid breaking changes both to React Components and CSS Classes so that upgrading for all developers should be trivial and painless. We will also offer ongoing long term support in terms of security and bug fixes for the v2.x.x release. You can see the updates to the React Storybook here: https://elements.reapit.cloud/?path=/docs/
This however is just the start and we are now looking ahead to version 3 of Elements. Version 3 will be a ground up re-write of the library, both implementing fully the new design language and responding to both internal and external developer feedback. The version will focus on three core areas of improvement:
Visual UI refinement and consistency, fewer components and clearer design patterns to implement.
Better documentation for both React and non-React users, including suggested use cases and composed components for off-the-shelf UI / UX flows.
Much smaller library with very little required JavaScript and very few dependencies. Elements will be about the visual presentation with developers free to make their own choices as to how to implement behaviours. This will mean a far better developer experience, especially for non-React users and a much more flexible, less opinionated library.
For more information about the latest release and news about Elements 3.0 (coming soon) please click here.
A new configuration option is now available when editing existing/creating new webhooks.
By default, webhooks will not be emitted when only the entity's eTag and modified timestamp has changed.
If you would prefer to receive notifications in this situation, please use the 'Ignore notifications where only the eTag has been modified' toggle option when configuring your webhook. See example below:
Existing webhooks will remain as they are and you can edit your webhooks at any stage from the 'Webhooks' page in the Developers Portal
To 'Request a Feature' or to 'Report a Bug' you can visit the 'Help' page in the Developers Portal. To help with understanding the process for each new issue raised, we have added a new section in our documentation 'Developer Requests'.
The new documentation will outline our processes, from what happens after submitting an issue to how your ticket will get triaged and categorised. Depending on the nature of the request or bug, it will determine which project board it may get assigned to. As our boards are public you will always be able to track the progress of any issue or request raised.
With the very significant increase in the number of listings carrying virtual viewings, we have introduced an additional 'Virtual' check box on appointments inside of AgencyCloud:
The virtual field is also now available in our 'Appointments' API in the Platform:
The latest version of the Developer Edition of AgencyCloud will include the new checkbox
With all enterprise customers now having access to the AppMarket, we wanted to use today’s What’s New update to highlight the features available to you on the ‘Analytics’ page in the Developers Portal.
The Analytics page provides useful information on the following:
A table to display the individual installations per client with a total number of installations per app
A graph showing the number of endpoints that are hit per day. You can also hover over a specific point for more information :
A full history of any installations or uninstallations that have occurred for your apps:
For a more granular level of information, you can download a month by month CSV of your transactions:
Any subscriptions or services you have subscribed to will be shown on the services chart and referenced by colour. Subscriptions/services may include, App Listings/Developer Edition of AgencyCloud/ Developer Registration etc:
You can use the ‘Cost Explorer: Cost & Usage’ section to view your current monthly subscription charges and navigate through previous months if required. We also provide a ‘Download’ option which will download this information in a CSV.
With an increase in apps now being submitted for approval, we have added a new section in our documentation ‘Listing an App’.
It covers, in detail, how to prepare your app before listing, what information is required, our testing processes and what happens when your app has been approved.
We have recently updated the Developers Portal to allow for 4 new fields on your App listing which can be managed when clicking on 'Edit Details'.
Terms and Conditions
Privacy Policy
Pricing Info
This Application is Free
For your App/Integrations to be submitted for approval and listed in the AppMarket, you will need to provide a secure URL (https://) for each field.
However, if your app is free of charge and occurs no cost to the end user, please use the ‘This Application is Free’ check box. If selected, you will not be required to enter your Pricing Information.
The information you provide in each field is then surfaced on your app listing in the AppMarket for agents to view:
If your app is ‘Free’, the pricing link will not be present on the app listing. A 'FREE' tag will be displayed when browsing the AppMarket:
The URL you provide for your ‘Pricing Information’ will also be presented to an agent on the install confirmation modal.
If you have provided a URL we will display the following new section under 'Pricing Information':
The latest release also includes a new ‘Launch App’ button after installation.
This will allow the agent to have the ability to immediately launch your App. This option is only available for AgencyCloud Apps (not available for ‘Integrations’)
As installations are only available to 'Admins', this is a great way to accelerate the onboarding process as it can be completed immediately.
‘Direct API’ has now been updated to ‘Integration’. This has been updated in the Marketplace, Developers Portal and all associated documentation.
Access between the AppMarket & the Developer Portal with one click! When you next log into the Developer Portal, you will see a new ‘Marketplace’ icon appear on the navigation. Clicking on the icon will take you to the Reapit AppMarket and automatically log you in using your Developer credentials.
To go back to the Developer Portal, simply click on the ‘Developers’ icon in the nav bar. The introduction of this flow will save time when testing and viewing your integration.
Included in the new access flow, you will now see a full list of live and available apps, in addition to your own applications that are still in development. Previously, with your Developer account you could only see your own apps.
Apps that belong to your organisation and that are ‘In Development’ (not listed) will be clearly be shown with an ‘In Development’ banner, see example below:
The ‘In Development’ banner will be visible on the ‘Browse’ apps page, ‘Installed’ & ‘Managed’:
App installation remains the same and you still will only have the option to install apps that belong to your organisation. You can of course view apps that belong to third parties but the option to install will not be present.
We are now supporting default mail client and browser loading for emails and external websites. If your AppMarket application presents an link to an email, you will need to update the mailto link to include the new AgencyCloud scheme ‘agencycloud://process/email?’
This will allow you to launch the users default email client and send to an address. An example would be:
This will create a new email in the user’s default mail client. It will do this by taking the value of the address parameter, prefixing it with mailto: and then starting a process with that argument.
Similar to the email link, using the scheme ‘agencycloud://process/webpage’ for a website page URL, will allow you to launch a webpage in the local default browser. An example would be:
This will launch the https://www.reapit.com site in the default browser. Note: the URL parameter must start with http for this to work.
For more information on the ‘Process’ scheme using the Desktop API, please click here
It has been just over a month since we went into full production for the Foundations Developer Portal and since we officially launched the Reapit AppMarket.
We currently have the following apps live and available for agents that have access to the AppMarket to install.
Access to the AppMarket is dependent on the migration from our Rackspace environment to our AWS Infrastructure. The Migrations Team are still working hard on finalising the list of agents that will be part of Tranche 1. Once this has been confirmed we will share this information with our App Partners.
In addition to the apps that are publicly available, we also have several apps and integrations that are currently going through their final testing phase, most of which you will be able to see and follow on our coming soon section.
The coming soon section is visible on the AppMarket and provides agents the ability to click on any developer or company they are interested in to send an enquiry email.
We have recently created a internal demo environment for us to be able help test and view your integrations using our office with the Customer ID ‘RES’. This new environment not only gives us the opportunity to see your integration or app in action, but it also allows you to further understand how the user flow is handled/presented outside of the sandbox installation.
If you wish to take part or setup a demo, you will need to list your app (tick the ‘is listed’ box on the app listing) and set 'Private App' to ‘Yes’ using Customer ID ‘RES’.
After submitting your revision, we will contact you directly to talk through the installation and what to expect.
Over the last few weeks we have been working closely with our developers to see if we can look to improve or enhance the functionality on the Developers Portal, please see below what we’ve been working on.
When you are ready to list your app, you will first need to complete your Organisation & Billing information. The Admin of your organisation will have access to this information from the ‘Settings’ page.
To complete your Organisation information, you will need to click on ‘Settings’ and select ‘Organisation’ You will then be required to fill in the following information:
Company Name
Telephone Number
Website Address
VAT/Company Reg and or National Insurance Number
About Us – The section will be displayed on any app listing in the AppMarket in addition to information about the app.
Company Address
Once completed, please then switch to the 'Billing' tab.
If you have an existing relationship with Reapit, you may already have a Reapit Reference. If so, simply enter your reference and submit. You can find your reference on any previous accounting correspondence.
We will then verify the reference and company information with our Accounts Department. This is normally completed the same day.
You will receive an email once your account has been set to ‘Confirmed’.
If you do not have a Reapit Reference, please then complete a Direct Debit mandate. It is an online form that will open in another tab. For those of you that have cookies disabled by default, and we know most developers do, you will need to enable them to complete the form. It’s an Adobe requirement, you can of course, disable as soon as you’ve signed the form.
Again, our Accounts Department will setup your account and you’ll receive an email with your new Reapit Reference. No need to do anything with the reference, as we will add this on your account automatically. Once received, you’ll be able to list your app or make any additional subscriptions.
Hopefully, you should have received an email from our Marketing team last week, which included the announcement of the following subscription fees suspended until March next year:
Annual Developer Registration
Developer Edition
App Listings
Reapit Connect
The idea and goal behind the suspension is that it should provide you a head start in the development of your app whilst the AppMarket and it’s users continue to grow.
In addition to this and quite exciting for us, Matt Goddard will now be leading our Reapit Partnership program. As the email quite rightly mentions, his knowledge and experience in the business will be an incredibly asset to you whilst you develop your integrations. Of course, our developers will still be available through Live Chat and I’ll be here to help if needed. Matt will be making contact with you in the coming weeks but if you have any questions, you can contact him here.
As you may be aware, only Reapit Admins have the ability to install or uninstall apps from the AppMarket. The Admins of an organisation are set by the individual office and are made aware of who has been assigned to the which role when they are migrated over to the new AWS infrastructure. However, to make it easier for you when speaking with Agents and for the users, we have introduced a ‘Role’ section within the AppMarket
.
When on the ‘Settings’ page – accessed by clicking on the company profile or group icon, will see a new field ‘Role’:
Those with a ‘Role’ set to ‘Admin’ or ‘Administrator’ will have the ability to install or uninstall apps.
Other changes we’ve been focusing on and something that will be coming soon.
Well, quite a lot actually! We are now in full production, which is a huge milestone for all of us. It does also mean with the new production environment, we have been able introduce quite a few new features.
With the production environment in full effect, we now have the concept of organisations. Previously, if you were building or testing in the developers portal for the same company, you would have needed to share an account or setup additional users under a separate account. Now, you can setup your own organisation and invite members to join you.
This means you can collaboratively build and test your integrations under one account. It’s worth mentioning that only an ‘Admin’ will have the ability to view your organisation information.
To invite members to join your organisation, simply click on the ‘Invite New Member’ button. The recipient will receive your invitation via email and will have the option to reject or accept. You can track the status of any members in the ‘Members’ table on the organisations tab:
Within the members section you will also have the ability to disable members and to set other members as ‘Admins’.
The ‘About’ field is a text box provided for you to give a bit of information about your company. This will then be automatically included on your app listings and will be visible to users viewing your app in the AppMarket:
Admins will also have access to setup and manage the account information for their organisation.
Account information will be required before an app can be listed in the AppMarket or before any subscriptions can commence.
If you are an existing customer of Reapit and already have an provided your account information, you can simply add your Reapit Reference (you will still need to submit some additional account information such as a contact name, email address etc). We will then send your information to our accounts department to be verified.
Once verified, your account status will be set to 'Confirmed' and you can continue with any subscriptions.
If you do have a Reapit Reference, you will be asked to complete an online Direct Debit mandate. Again, your information will be sent to our accounts department to be setup and once complete, you account status will be set to ‘Confirmed’ and you will automatically be provided with a unique Reapit Reference which we will add the billing page for you.
All subscriptions such as the annual App Listing fee, annual Developer registration & API Consumption Costs will then be added to your monthly Direct Debit. A break down of any subscription costs can be found on the ‘Cost Explorer’.
We have now increased the character limit for the ‘Description’ field on your app listings. This will provide more room for additional formatting. The character limit has been set to 1,500. Remember, as the description field is using HTML, some special characters will count against the total, so we still advise on keeping the content as direct and concise as possible.
Over the Reapit Foundations public beta period, we have been working to improve the experience for AppMarket App Developers. Today we are announcing some significant updates to our front end tooling for web developers.
Firstly we have released a new Create React App template to replace the scaffolder we demoed at the November launch. As before the template represents the quickest way to get started building AppMarket Apps, now with the added benefit of long term support, familiar CLI and stability from the React Scripts package.
We have also given a lot of attention to making the Reapit Connect OAuth flow as smooth and simple as possible. This has taken the form of a new, lightweight NPM Package, Connect Session. The module handles all OAuth re-directs, session caching and refreshing. There is a browser version that works with any front end, a Node version for server-side apps and a convenient Hook for React users. We have also integrated Connect Session into an embeddable “Sign in With Reapit”, button that is served from a CDN and returns a Reapit Connect Session without the need for any package installation or tooling.
Finally, we have released a stable v1 of the Elements UI library. This will guarantee long term support and a stable API for our React Components and style guide package. We haven’t stopped there though, Elements v2 is coming later this year with a much better experience for non-React users, simpler API, improved documentation and smaller bundle sizes.
For full details visit the new App Development section of our documentation here.
From today, you will now be able to subscribe to 2 new Webhooks. ‘Application Install’ and ‘Application Uninstall’.
Each Webhook will trigger a notification when your app is installed or uninstalled and the payload will include the following information:
Customer ID (ID of Estate Agent) Customer Name (Name of Estate Agent) Customer Address (Address of Estate Agent)
Setting up a Webhook is simple and easy to do. For more information on Webhooks please visit the documentation here
Following the recent successful launch of the Developer Edition of AgencyCloud, we have been gathering feedback on what we can do to help you further test your integration within our Desktop Software.
For the last couple of weeks, our Desktop Team have been working hard behind the scenes and we are pleased to announce a brand-new feature, ‘Remote Debugging’.
With the remote debugger you can inspect, in real time, Chromium Developer Tools. You will notice the button appear on your app and simply clicking this button will launch a separate window which hosts the developer tools.
For more information on the Desktop API, please click here
The list of available AgencyCloud Integration types has been updated and now include the following additional options:
Landlord
Contact
Company
Tenancy
Offer
Sales Progression
Chain Management
You can select the type of integration your app requires on the ‘AgencyCloud Integration’ section when you edit your app listing.
The list will continue to grow as we understand more about what our developers are building and how they wish to integrate within Agency Cloud.
For more information on Integration Types, please click here.
The highly anticipated Developer Edition of the Reapit AgencyCloud CRM is now available to download. This is an incredible milestone that we have been working very hard to deliver and is now available to our developers free of charge during the Beta Phase.
You will have the ability to test your app and interact with sandbox data using the CRM interface. Seeing in real time how customers will use and view your app inside the desktop application.
For more information, please visit the ‘Desktop’ page within the Developers Portal.
The latest release has redesigned the way you submit an app. It is now easier to get building & testing through Foundations.
When you submit an app through the Developers Portal, you will be presented with a step-by-step wizard and will only need to provide an App Name, select/provide the authentication method & permissions (scopes). Once completed you will be presented the relevant access tokens/ID's to work with our APIs.
There is no requirement at this stage to add an icon/images/description etc until you are ready to list your app in the AppMarket.
When your app is ready to be listed, simple tick the ‘Is Listed’ box on the ‘Edit Details’ page. This will then let you know what information is needed to ensure your listing is meets the requirements to be available in the AppMarket. You can find more information on providing your app listing content, here.
For more information on submitting an app, please click here.
We have changed how we handle app revisions. Previously, any revision (edit) would need to be approved by our Admin team. This understandably meant a slight delay and prevented any further revisions as your app was in a ‘Pending Revision’ state.
Thanks to the recent update in the Developers Portal, general revisions no longer require Admin approval, meaning no more delays.
The only time your app will be required to be approved by our Admin team, will be when you are ready to list your app in the AppMarket. This is triggered by the ‘Is Listed’ status when editing your App.
Along with the new app listing pages, as mentioned below, we are currently working on a simplified submit app wizard, which will change how we handle the requirements when editing your app. More on this to follow soon.
We are pleased to announce that the App listing pages in the Developers Portal have been updated. This means you will now be able to add a more detailed description including bullet points, paragraphs, external links, and a featured image.
The description and imagery you upload, are incredibly important to help capture the user’s attention.
With that in mind we have also added a ‘Preview’ feature. When you next open your app, you will see a ‘See Listing Preview’ option. It will open a new tab displaying your app listing exactly as it will be seen by users inside the AppMarket.
To maximise the space and to truly showcase your app, we have put together the following tips/guide to help.
The summary is a short description about your app and will be one of the first things shown in the AppMarket before a user clicks through for more information.
Users should be able to clearly see what your app is about when browsing. You have a maximum of 150 character to utilise which will be displayed on both the app tiles and on your app listing.
Your company icon will be shown on the left hand side of your app listing in the AppMarket.
The suggested image size is 96px x 96px and the app icon is the first opportunity to communicate, along with the app summary, what you are offering. We recommend keeping the logo simple but should be recognisable and understandable. The icon will be placed on a white tile and background so ideally avoid text, screenshots or photos.
The featured image is 495px x 222px and it will appear at the top of your listing page as the first graphic representations of your app before any screenshots. It may also be used for marketing within the portal under our ‘Recommended Apps’ or ‘Featured Apps’ sections as well as potentially used for external communications.
With that in mind, we are looking for the Featured Image to be more of a graphic/advert style rather than a screen shot of the application. Ideally it should convey your app’s value proposition.
The next step after a user discovers your app in the AppMarket, is to read more about it.
Creating a detailed and accurate description of your app is what will give users the full understanding of what your app has to offer. Appealing enough to encourage users to install.
The description field on the app listing has been converted to support HTML. This means that you can now use paragraphs, bullet or numbered lists, headings and external links.
The focus should be on conveying the value of your app and should work alongside the images you provide.
A great way to think about how to format your description is to picture yourself as the user and what would appeal to you about your application, what problem exists and the solution it provides.
You have the option of uploading 4 screenshots on your app listing and we recommend images sizes of 598px x 457px
Whilst screenshots give the user the ability to see your app in action, you can create the screenshots to include text to highlight the important features. Really maximise the space and visual impact of your app listing
2 screenshots are placed directly under the ‘Summary’ and the other 2 are placed below the ‘Description’.
You can add a bulleted or numbered list of key features within the description.
Key features should be quick, short paragraphs. Help your users to easily see the main value that your app provides. Focus on the benefits. For example:
Mobile Friendly
Easy to Install
Helpful Hints
Simple Reporting
We are now supporting external links which allows you to navigate your users to your own website.
You can use this feature to perhaps link to your own website with a dedicated page with more information or video demos of your application.
Maybe even provide instructions on how to register an account with you or details on how to get in touch to your sales/support team.
If you have more information you want to share with the users, external links are a great way to achieve this.
With the launch of the Beta Phase for the Foundations Developers Portal and with several more developers and PropTechs joining the Platform, we have been pretty busy the last few weeks. It has been great to see some of the applications that are being developed and also having the opportunity to see them in action with live demos . Our Development team have been concentrating on delivering the following new features in the Developers Portal which we are excited to share with you.
With Foundations, you can now create a Webhook subscription which will allow you to be notified about changes as they happen to your chosen Endpoint.
Setting up a Webhook is very simple and can be created from the new ‘Webhooks’ page in the Developers Portal here
It will give you the ability to chose which events to listen to with the option to select specific customers or all customers (once installed) for your selected applications.
We currently support subscriptions to events for a wide range of entities. For each type, you can choose to subscribe to created events, modified events (changes) or both. You will only be able to select topics based on the permissions assigned to your app.
Also, another very neat feature is the new ‘Ping’ option. Allowing you to test, in real time, your subscriptions to your chosen secure URL.
For more information on Webhooks please click here
Now you may have seen how our demonstration of how the desktop integration types will work when the Desktop API is ready, if not, you can see it in action here:
In the video, it is showing how the Homeflow application set a desktop type of ‘Property’. This means that within AgencyCloud, the application (after being installed) will appear within the native Property Screen.
You can set your Integration Type when Submitting or Editing your app in the Developers Portal. Whilst we are still in Beta Phase the current Integration Types are still in development but you can follow the progress here
An additional tab has been added on the ‘Analytics’ page, the ‘Cost Explorer’. This will provide you with detailed information on the individual costs for each Resource, Webhook & Service.
The ‘Services’ bar chart will give you a month to month total of your cost (excluding VAT).
But for a more detailed breakdown you can use the ‘Cost Explorer: Usage & Cost’. This will provide the ability to see on a granular level, the amount you are spending on each Resource. Notably, until the AppMarket is live and you have app installations, you won’t see any traffic but you can an example below:
Selecting the ‘Configuration’ entity from the table, I can see the breakdown of the specific endpoint my apps have been interacting with, how many API calls have been made and the total cost for that month.
You will also be able to download a CSV file with the full ‘Transaction History’ per month for all your applications.
Finally, with the Cost Explorer we have also added a new feature the ‘Cost Calculator’. The calculator is interactive and provides a quick way to see the estimated cost for endpoints used against Monthly API Calls.
As we are working on developing the Client Portal (AppMarket) we want to ensure your app will be presented in the best way, this means providing the ability to add a better formatted description.
The ‘Description’ box when submitting or editing an App, has now been updated to support HTML. You can create headers, bulleted or numbered lists, line breaks and paragraphs.
We are also supporting ‘External Links’ which will no doubt be very handy to provide more information about your company and your app for potential clients.
Elements Storybook now also supports a vanilla HTML. Simply apply the classes to your markup as displayed in the HTML tab in each Storybook component as per below:
The ‘Submit’ button has moved to the ‘Apps’ page. To submit your app, click on ‘Apps’ from the navigation bar and use the ‘Create New App’ button.
We have officially started the Beta Phase! If you had signed up to the Alpha Phase, you will be able to continue using the platform with no interruption, this is simply the next phase for the Developers Portal. For our new Beta Developers, welcome to Reapit Foundations. If you didn't get the chance, have a look at our on-boarding video here. It has been created to help you navigate the portal and to demonstrate what is available. Remember, if you have any questions or need any assistance, you can visit the 'Help' section.
What’s New has been designed to give you a high-level overview of the latest features and fixes that have been included over the last couple of weeks.
With that said, let us take a look at what we’ve been working on:
A new section is now available in on the Submit and Edit app forms, giving you the ability to specify which customers you would like to share your application with. You can enter the Customer ID or IDs and when the AppMarket is live, only those customers will see your application in the AppMarket. It is especially helpful to those building in private in-house applications.
For more information, please click here
The Analytics section has had a significant update, you can now see the specific Endpoints and ‘Total’ number of hits for your App(s) as well as a graph displaying your ‘Hits Per Day’. As the data is Sandbox data you will see ‘SBOX’ in your client filter list, but this will include Client IDs when your app has been installed in the AppMarket.
In addition, you can now search the data using a date range filter or simply select a predefined option of ‘Yesterday’, ‘Last Week’ or ‘Last Month’. More to come on the Analytics page in the coming weeks.
A new ‘Tags Input’ component has been added to Elements. We will be using this on the Submit and Edit app forms shortly, but it is available for you to use, as are all the components in Elements. Selecting an item from a drop-down list, it will automatically add as a tag in the field. It also offers a hover over state allowing the user to clearly see a brief description regarding each selection.
To see the new the component, please click here
Over the last couple of weeks we have been working on implementing a couple of new features, for example the Pending Revision modal as mentioned below. In addition and coming soon a new update to the 'Analytics' page within the developers portal which will provide additional and useful app statistics.
Pending Revisions
We have now introduced the ability to view what revisions are currently pending and the option to ‘Cancel Pending Revision’.
When you have submitted a revision on your app, you will now be able to click on the ‘Pending Revision’ button (previously disabled) which will present a modal with the changes you have made highlighted.
For text or selections that has been added it will be highlighted in GREEN and for text deleted or options deselected, it will be highlighted in RED.
If you wish to cancel your pending revision to make additional changes for example, click ‘Cancel Pending Revision’. It will immediately cancel the revision and you will be able make any edits as usual.
There was a slight issue with the ‘Checkbox’ component in Elements not behaving correctly. This has been fixed and is now working as expected.
The Journal API is now read and write and available within the Interactive API explorer. It has the ability to read and write dated event information into the Reapit Journal system and automatic generation of these events from other services.
In addition, the Enquiries API is also available and gives the ability to read and write information about new leads into AgencyCloud.
I’m pleased to confirm it has been another successful week in the Alpha Phase, not only have we been able to deliver ahead of schedule in terms of a few of our Milestones, I have also had the pleasure of speaking with you all and gathering your feedback regarding the Foundations Platform. We still have a few weeks to go until the end of the Alpha and already we have had quite a few entries for the Early App Program.
Towards the end of March, we will be contacting those wishing to participate to confirm the specific details but if it is something you wish to take part in, please be sure to get in contact with our Marketing team. Remember, this is a great opportunity for your application and brand to be visible in the Marketplace.
Now let’s look at what we’ve been doing:
The release of the of Tenancies API The ‘read’ functionality of the Tenancies API is now available. We are still developing the ‘updating’ and ‘creating’ functionality, but you should now get great visibility what is available and what information you can use within your application.
To follow the milestone to see what is still to come and follow the progress, please click here
Works Orders API In addition and ahead of schedule, the ‘Works Order API’ is now up and running and fully interactive, read, write and update with the Sandbox data to see exactly what information you can use within Property Management.
Embedding Data Now available in the Interactive API Documentation, the option to request additional resources when making a GET request on our APIs.
If your application requires data from one or more related endpoints, you can simply specify the name of the related resource from the list provide in ‘Embed’ section and our APIs will do the rest.
For more information of this feature, please click here
Custom URL Schemes We are now supporting Custom URL Schemes for your App, for the ‘Redirect URI’ and ‘Sign Out URI’ fields.
For example, ‘myapp://’ is now an accepted format, previously it was causing an issue when trying to save on a ‘Submit’ or ‘Edit’ app page unless the format was https:// or http://localhost
Don’t forget, whilst the ‘What’s New’ page will give you a brief look at some of the things we have been working on, the Platform Change Log and coming soon ‘Web Change Log’, will give a more detailed list on the issues we have been addressing. Click here to the view the ‘Platform Change Log’
To follow the release of our Web Change Log, please click here
Firstly, thank you to all our Alpha partners for your feedback during the first week of the Alpha Phase. It has been incredibly useful in helping us make the necessary changes and updates that ultimately deliver a better experience for you.
Whilst we continue to update the system in the background, here are the highlights of the things we’ve been doing:
Changes We have added a more informative way to display if the incorrect number of characters had been used in the ‘Summary’ and ‘Description’ fields on the ‘Submit’ app form. Previously, this wasn’t very obvious and resulted in delay when submitting an App.
Fixes Thanks to Navin Mahendran who reported an issue with the Scaffolder when trying to scaffold an app in the Windows Shell. I’m pleased to confirm this has been fixed and is ready to use immediately.
Bugs - Interactive API Explorer An issue was detected with the ‘CURL’ response, resulting in seeing an ‘Undefined’ error. This is now displaying the correct response.
A missing comma from the JSON response has been found and is now back in place. A well spotted bug from Erol Ziya.
Also, we would like to give a quick thumbs up to those that have used the Live Chat feature and reported a bug directly on our board. It’s proving to be a great way for us to stay in communication and hopefully helping you navigate through the Developers Portal.
What’s new? Well… everything! We have officially gone live with Reapit Foundations. Not only have we decided to create an independent Marketplace for all our AgencyCloud Users but it comes complete with a fully stocked Developers Portal, plus we’ve open sourced everything!
We want to share with you all we can in order to help you develop and interact with our Foundations Platform.
So, let's recap on a few things that we've been up to since the initial launch in Nov 19…
Open sourced code ✔
Easy to understand and follow documentation ✔
Interactive APIs ✔
Single-sign on and identity service ✔
New cloud infrastructure ✔
UI Storybook of usable components ✔
Feature requesting ✔
Public Roadmap. ✔
I think it's fair to say, we’ve been busy!
Our Developers have been working incredibly hard and we are all excited to see Reapit Foundations come to life. Each week, I’ll be featuring the best of our releases and talking about the exciting new features we have introduced into the Foundations Platform, as well as sharing updates on our APIs as they happen.
So, this week is the start of the very much anticipated Alpha launch. With that in mind, let me talk you through just a few of the features our new Developer Portal has to offer:
Those of you familiar with GitBook, will know they are the leader in the industry for organising and detailing technical documentation. We’ve used the best of the best to ensure you can find and reference what you need as easily as possible. We know the importance of documentation and want you to have the right tools. You can access the documentation from within the developers' portal from the 'Docs' page.
Available for a limited time only, direct access to our Foundations Platform Product Owners and Developers. You can access this feature from the ‘Help’ section in the developer portal. We hope you won’t need us and that everything you need can be found within our documentation but it’s nice to know we’re here if you do.
From every issue raised through to completion, you’ll have full visibility on what we’re doing. We want you to be a part of this exciting new platform, which is why we’ve opened sourced not only our cloud applications but also our developer portal! Giving you the ability to submit feature requests or to raise bugs directly on our Foundation Repo and track the progress.
These are only a but a few of the features we have included with many more still yet to come. If you're interested, we will also soon be including a release note section, giving you detailed information on everything that has been changed, fixed or showcasing something new.
Feedback is important! We have spent a long time creating the Developer Portal and we know it inside out but it helps to hear what you think. So, whilst you are reading through the Documentation, testing the endpoints, or simply navigating through the Portal, we want your feedback. We don't even mind bugs! It's the Alpha Launch, all feedback is welcome. Remember, you can use the Request a Feature or Report a Bug from the 'Help' section to get in contact.
Updating the ‘brochureId’ field on the ‘Selling’ and/or ‘Lettings’ models with a document ID, will set a PDF as the predefined property details. Please see an example in the Property Details screen from within AgencyCloud (Desktop CRM) below:
Should you wish to continue using Webhooks for Sandbox testing, you can reactivate it again by selecting the check box ‘Active’ when editing.
managerId field
attended field in the Appointments API
reserveAmount field in the WorksOrders API 
responsibleParty
