Hayylo offers 3 main methods for integrating your account Hayylo account with your primary data source of truth; your Care Management System (CMS). The 3 methods are:
- Hayylo adapter
- Cloud integration
- Inbound API
Depending on the CMS that you organisation uses, the preferred Hayylo approach is to use one of the pre-built Hayylo adapters, or Cloud integrations. In these two cases, the pre-built integration (adapter or cloud) will be responsible for retrieving your CMS data and loading it into your Hayylo account on regular intervals. However, if your current CMS is currently not supported, the option of using the Hayylo Inbound API is available.
Integrating your Hayylo account with your CMS via the Inbound API means that your organisation will be responsible for regularly retrieving the required data (client, family, worker and schedule) from your CMS and sending it to Hayylo. This process should detect and retrieve any new or updated (or cancelled, in the case of schedule data) data from your CMS and submit it to the Hayylo Inbound API in bulk. The data will then be processed and loaded into your account.
This retrieval, change detection and data sending process is typically implemented by organisations using a middleware solution, such as Dell Boomi.
Below is a diagram that describes the process.
For further technical details on the Inbound API, including API specs, please see this page: Hayylo Inbound API