Civica Cx
Last updated
Last updated
You can integrate your TenantWise platform with the Civica Cx API. The API integration can be easily configured by an admin from the 'Integrations' section of the Dashboard.
You will require a Civica Cx user with API permissions before completing the integration.
From the 'Integrations' section of the Dashboard switch the 'API Integration Disabled' dropdown to 'Enable API Integration'.
Enter the API URL, username and password and save the changes and refresh the page.
(Note: the API URL is the base URL of your Cx instance e.g. https://cx.yourdomain.com)
The available companies from your Cx instance will be retrieved if the connection is successful. If TenantWise is unable to get the available companies, ensure you review the 'IP whitelisting to Civica Cx' section of this guide.
Set the Cx company from the 'Selected Company' dropdown and save the changes.
You can now click the 'Test API' button to test the connection to your Cx API. If the connection was successful you will receive a success notification at the top of the screen.
If you wish for customer repairs to be retrieved on or after a certain date, you can set a repairs start date. This allows you to limit the repairs a customer will see by their creation date. Setting a repairs start date will also limit the appointments that are linked to a customer repair.
Use the date picker to set the 'Repairs Start Date' from the Integrations page of the Dashboard.
Note: if repairs have already been retrieved for a customer and you change this setting after the retrieval, customers will need to wait until the repairs API refresh timeout before seeing limited repairs.
If you wish to control whether a customer can cancel their repairs, you can toggle this in 'Repairs Settings'. Repairs cancellation is enabled by default.
Additionally, you have the option to specify the number of days notice a customer must provide to cancel an appointment. This value is 0 by default which means a customer can cancel a repair at any time prior to the appointment date.
In order to ensure TenantWise is performant for customers, customer data from the Cx API is stored in your instance cache until the API refresh timeout expires.
When a customer logs into the platform, their data is retrieved live from the API. Their data is then cached and the next time they make a request to the platform the data is retrieved from the cache which greatly improves page load times and decreases load on the Cx API server.
You can control API refresh times from the 'Integrations' section of the Dashboard. Set the number of minutes you want the customer data to be cached for and save the changes. Once the data is X minutes old, the data will be retrieved from the API again.
We recommend refresh times of 15 minutes to ensure a good customer experience.
If your Civica Cx API has firewall restrictions, you will need to allow your TenantWise instance IP addresses so that TenantWise can successfully communicate with Cx.
Your instance IP addresses are available in the 'Integration' section of the Dashboard.
Note: the IP addresses in the screenshot may be different to the ones for your instance.
