Integrating Deputy with Nourish (BETA)
| Note: Some features or functions mentioned in this article are currently in beta trials and may not be visible in your account. |
The Deputy and Nourish integration helps care providers keep team member information up to date across both platforms by syncing employee details from Deputy to Nourish. This can reduce duplicate data entry and make it easier to manage staff information in one place.
Before you read
- Target audience: This article is for users with System Administrator access.
- Plan restrictions: This feature is available on all Deputy plans.
This article covers:
- How does the Deputy and Nourish integration work?
- What information syncs from Deputy to Nourish?
- How do I connect Deputy to Nourish?
- How do I check the sync status?
- How do I troubleshoot sync errors?
- FAQs
How does the Deputy and Nourish integration work?
The integration allows team member information to sync from Deputy to Nourish, helping you manage employee records without needing to update the same information in both systems.
Once connected:
- Deputy acts as the source of truth for team member information.
- Employee details are scheduled to sync from Deputy to Nourish every 15 minutes.
- Changes to employee information in Deputy can be reflected in Nourish during subsequent syncs.
- You can request a sync at any time using Sync now.
- Each Deputy location requires a separate connection to Nourish.
Note: The integration supports one-way syncing of employee information from Deputy to Nourish. Changes made directly in Nourish are not synced back to Deputy. Resident information is not included.
What information syncs from Deputy to Nourish?
The integration syncs team member details from Deputy to Nourish. Team members need to have the required information in Deputy before their records can sync.
Required information
- First name and last name
- Email address
- Job position that matches an existing role in Nourish
- Assignment to a connected Deputy location
If required information is missing, the team member is skipped during the sync and flagged in Deputy.
Follow the Editing your Team members' details article to learn about updating this information.
Important: Each team member's job position in Deputy needs to match an existing role in Nourish. If the role doesn't exist in Nourish, the employee record may fail to sync.
Additional information
The integration will also sync the following team member details, if they are recorded in Deputy:
- Personal details: Display name, date of birth, and gender.
- Contact details: Mobile number and address, including city, state or county, country, and postcode.
- Employment details: Start date, termination date, and active or inactive status.
Note: Syncing mobile numbers can replace phone numbers entered directly in Nourish. Gender information is sent to the Gender Identity field in Nourish, not Sex at Birth. Supported values are Male, Female, Non-binary, and Prefer-not-to-say.
The integration generally sends employee records when changes are detected in Deputy. Records without changes are skipped during subsequent syncs.
How do I connect Deputy to Nourish?
Each Deputy location needs to be connected to Nourish separately using its own integration token. Before connecting, review the required employee information above to help avoid sync errors.
Generate an integration token in Deputy
-
Click your name in the top-right corner of Deputy and select Integrations
-
Search for and select Nourish from the Integrations list.
-
Choose the Deputy location you want to connect, then you will be able to Generate and Copy the token.
Connect Deputy in Nourish
In Nourish, go to Administration > Extensions. Extensions, find Deputy and toggle it on for the service or area you wish to connect. You will then need to paste the integration token copied from Deputy and hit Confirm.
Sync your team members
Once the connection is established, you can request an initial sync from Deputy by returning to the Nourish integration page in Deputy and selecting Sync now to request a sync.
We recommend you review the employee sync statuses and check the results.
After the initial sync, Deputy checks for employee changes every 15 minutes and sends eligible updates to Nourish.
Note: If you have multiple Deputy locations, repeat the connection process for each location using a separate token.
How do I check the sync status?
You can check the status of each employee on the Nourish integration page for the connected Deputy location.
Each employee may display one of the following statuses:
- Synced: The employee's information has been synced to Nourish and is considered up to date.
- Ready to sync: The employee has the required information and is waiting for the next sync.
- Add [field] in Deputy: The employee is missing required information. Add the specified details in Deputy.
- Sync failed: Nourish rejected the employee record. Review the error message for more information.
The time of the last successful sync is also displayed on the integration page.
How do I troubleshoot sync errors?
If an employee record fails to sync, an error message may appear in the failed employees panel above the employee table in Deputy. Review the message to identify the issue and the suggested fix.
Important: Make corrections to employee information in Deputy. Changes made only in Nourish may not trigger another sync attempt because the integration checks for changes in Deputy.
| Error message | What happened | How to fix it |
|---|---|---|
| Nourish doesn't recognise the job position "X" | The employee's job position in Deputy doesn't match an existing role in Nourish. | Check the available roles in Nourish and change the employee's job position in Deputy to match. |
| Missing details Nourish needs: … | One or more required employee fields are missing in Deputy. | Add the missing information listed in the error message to the employee's profile in Deputy. |
| Another Nourish staff member already uses this email address | The employee's email address is already associated with another staff record in Nourish. | Check the email address in Deputy and change it to one that isn't already associated with another staff member in Nourish. |
| Nourish rejected this email address as invalid | Nourish rejected the employee's email address because it doesn't meet the required format. | Check the email address in Deputy for errors and correct it if needed. |
| Nourish rejected this employee's details | Nourish rejected the employee record, but the integration couldn't identify a specific reason. | Review the employee's information in Deputy for missing or incorrect details and make any necessary corrections. If the issue continues, contact Deputy Support for further assistance. |
FAQs
Why isn't a team member syncing to Nourish?
+
Check the employee's sync status in Deputy.
Common reasons include:
- Missing required employee information.
- A job position that doesn't match an existing Nourish role.
- An email address already assigned to another employee in Nourish.
- An invalid email address.
Review the employee's information in Deputy and make any necessary changes. See How do I troubleshoot sync errors? for more information about specific error messages.
How often does Deputy sync with Nourish?
+
Employee information is scheduled to sync every 15 minutes.
You can also select Sync now on the Nourish integration page in Deputy to request an immediate sync.
Can I connect multiple Deputy locations to Nourish?
+
Yes. Each Deputy location can and must be connected separately using its own integration token.
What happens if I disconnect a location?
+
Disconnecting a location stops Deputy from sending further employee updates to Nourish for that location.
Employee records already in Nourish remain there.
To reconnect the location, generate a new integration token in Deputy and enter it in Nourish.
Why am I being asked to reconnect the integration?
+
A reconnect notification may appear if Nourish rejects the integration credentials for a location. This can happen when the token in Deputy no longer matches the token stored in Nourish.
Generate a new token in Deputy and update the connection in Nourish.
The notification should clear after a successful sync.
Does the integration sync resident information?
+
No. The integration is designed to sync employee information from Deputy to Nourish. Resident information is not included.
Can I update employee information directly in Nourish?
+
Deputy acts as the source of truth for employee information used by the integration.
To help keep employee records consistent across both platforms, make changes to employee information in Deputy. Eligible changes can then be reflected in Nourish during subsequent syncs.
Why has the integration stopped syncing without showing an error?
+
The integration uses the permissions of the person who originally connected the Deputy location. If that person leaves the organisation or loses access to the location, employee information may stop syncing without displaying an error.
Check whether the person who connected the integration still has access to the relevant Deputy location.
If the issue continues, contact Deputy Support for further assistance.