Calendar Sync

Calendar Sync connects SuiteCRM to an external calendar (Google Calendar or a CalDAV server) so that your meetings synchronise bidirectionally — updates in SuiteCRM appear in your external calendar, and updates in your external calendar appear in SuiteCRM.

Each user manages their own connection through the Calendar Accounts module.

Prerequisites

Before creating a Calendar Account, confirm the following:

For Google Calendar:

  • Your administrator must have configured an External OAuth Provider in Administration > External OAuth Providers.

  • You must create an External OAuth Connection via Profile > External OAuth Connections. Select the Google provider your administrator set up.

If the OAuth Provider is not available, contact your administrator before continuing.

For CalDAV:

  • You will need your CalDAV server URL, username, and password. See CalDAV Provider Guide to find the correct URL for your server.

For all providers:

  • The SuiteCRM scheduler must be running and the Calendar Accounts Sync job must be active in Administration > Schedulers. Without this, only manual sync is available. Contact your administrator if you are unsure.

Setting Up Google Calendar

  1. Go to Profile > External OAuth Connections and create a connection using the Google provider. Save it.

  2. Navigate to Calendar Accounts and click Create Calendar Account.

  3. Enter a Name (for example, "My Google Calendar").

  4. Set Calendar Source to Google Calendar.

  5. Select your OAuth Connection from the list.

  6. Click Authenticate. A popup opens the Google authorisation screen.

  7. Sign in to your Google account and click Allow.

  8. The popup closes automatically when authorisation is complete.

  9. Click Save.

Your browser must allow popups from your SuiteCRM domain for the Google authorisation flow to work. If the popup is blocked, enable popups for SuiteCRM and try again.

Setting Up CalDAV

  1. Navigate to Calendar Accounts and click Create Calendar Account.

  2. Enter a Name (for example, "My Nextcloud Calendar").

  3. Set Calendar Source to CalDAV.

  4. Enter your Server URL, Username, and Password.

    If you are unsure of the correct URL, see CalDAV Provider Guide.

  5. Click Save.

Testing the Connection

After saving a Calendar Account, re-open it in Edit mode. A Test Connection button will appear. Click it to verify the connection, then click Save again to record the test result.

The Test Successful field on the Detail View will show whether the last test passed.

Manual Sync

From the Calendar Account Detail View, click Sync Now to trigger an immediate synchronisation without waiting for the next scheduled run. Use this after making changes or to confirm the connection is working.

Sync Status

The Calendar Account Detail View shows read-only status fields updated after each sync:

  • Sync Status: current state: In Progress, Success, Warning, or Error.

  • Sync Message: details from the last sync run.

  • Last Sync Date: when synchronisation last completed successfully.

If the sync status shows an error, check Sync Message for details. Contact your administrator if the issue relates to OAuth configuration, the scheduler, or server connectivity.

Administrator Resources

For global sync settings, scheduler configuration, and advanced troubleshooting, see the Calendar Sync Administrator Documentation.

Content is available under GNU Free Documentation License 1.3 or later unless otherwise noted.