In this article
Objective
Integrate GSuite with Coconut to provide staff members with the ability to sync and view appointments in either application.
User Benefit
The GSuite Integration keeps GSuite calendars and Coconut schedules in sync for appointment-taking staff members at your organization. This helps prevent double-bookings. What’s more, the integration uses staff members’ existing calendar events to determine availability for online booking by clients.
Before you begin
The integration requires specific information from your GSuite domain.
Scopes
The following scopes are required for a successful integration:
Calendar Read-Write (https://www.googleapis.com/auth/calendar)
This enables reading/writing to users’ calendars
View users on your domain (https://www.googleapis.com/auth/admin.directory.user.readonly)
This enables importing user information for scheduling purposes
View groups on your domain (https://www.googleapis.com/auth/admin.directory.group.readonly)
This enables importing users from a specific group
NOTE: This scope is necessary if some - but not all - GSuite users will be using the integration
Directory Info
The following directory information is required for a successful integration:
Directory User Email
This email is used to impersonate users in order to sync with their calendars
NOTE: This email must be associated with a GSuite admin account
Directory Group (if not all GSuite users will be using the integration)
This group is the collection of users that will be synced using the integration
NOTE: Only users included in this directory group will be successfully synced
Hot Tip!
Coconut recommends that a new Integration Account role be created for the integration, and a new admin user created and assigned to this Integration Account role. This limits the access Coconut has to your organization’s GSuite while still ensuring a successful integration.
Steps
Enabling the integration requires steps be completed in both your Google domain admin panel and in Coconut.
In your Google domain admin panel
Enable the required scopes in your Google domain admin panel (admin.google.com) to allow API access
Create an Integration Account role in your Google domain admin panel
Create a new GSuite user and assign the user the Integration Account role
Create a new GSuite group
Add the email addresses for each user who will be using the integration to the new GSuite group
For more details on each of these steps, please refer to this article in our developer documentation.
NOTE: If setting up the integration in a demo environment first, use the following value for Client Name: 104125833309582795507.
In Coconut
Once the prerequisite steps are completed in your Google domain admin panel, the integration can be connected in Coconut. To enable the integration:
In Coconut, from the navigation menu, click Settings
From Integrations & API, click GSuite
Hot Tip! If GSuite does not display in your organization’s settings it indicates the integration is not yet enabled by Coconut; please reach out to your customer success contact to have the integration enabled
In Directory User Email, enter the email address for the GSuite user assigned the Integration Account role
NOTE: This user must have admin privileges in GSuite
In Directory Group, enter the email address for the group that includes all users who will be using the integration
Click Connect
If your organization wants to include a client/member’s ID in the calendar event’s description field, check Include client ID in the synced event description
Hot Tip! Coconut recommends leaving this option unchecked if your organization does not want client/member IDs shared with staff members
Click Save
Once setup steps are completed in your organization's Google admin panel, the integration can be connected to Coconut by accessing GSuite in Settings.
Transitioning from a demo to production environment
If your organization is connecting the GSuite integration in a demo environment first, and then will transition to a production environment, Coconut recommends the following workflow:
Connect the integration in your demo environment
Test the integration
Disconnect the integration
Update the Client Name value
NOTE: This can be found in this article in our developer documentation
Connect the integration in your production environment
NOTE: Coconut recommends completing this step 24 hours after disconnecting in your demo environment
A note on access and visibility
Admin users can connect the GSuite integration through Settings in Coconut. Note that setting up the integration may also require effort from your organization’s IT team, depending on how your permissions and access are structured for your Google domain admin panel.