Custom Contacts

Custom Contacts Settings

The Custom tab allows integration with a third-party or self-hosted contact management service. Administrators can define the connection details for syncing:

• Enable Sync: This toggle controls whether automatic synchronization with the external contact source is active.

  • No: The configuration will be saved, but no synchronization will occur regardless of the value set in Sync Interval (hours). In this case, contacts will not be synced until the user manually triggers the sync by clicking the Trigger Sync button.

  • Yes: Once the configuration is saved, the system will immediately perform a full synchronization of all contacts from the external source, and continue to sync them periodically based on the interval defined in Sync Interval (hours).

  • After the initial full sync, all subsequent sync operations will only process newly added, edited, or deleted contacts, ensuring efficient updates without re-importing all data.

This setting gives users control over whether syncing begins immediately or remains inactive until explicitly triggered.

• Name: Name/label for the custom source.

• Sync Interval (hours): Time interval for periodic automatic syncs. Default is 24 hours.

• Client ID: Login ID to authenticate to application.

• Client Secret: Secret key/password associated with the client ID.

• URL: Endpoint of the custom contact server (e.g. https://example.com:5555).

• Trigger Sync: Immediately starts a manual synchronization process with the external contact source. Upon clicking, users are prompted with a confirmation dialog: "This action will trigger sync immediately. Are you sure you want to continue with this action?"

  • If this is the first time the sync is being triggered (i.e., no previous sync has occurred), the system will perform a full synchronization, importing all available contacts from the external source.

  • On subsequent uses, only newly added, edited, or deleted contacts will be processed and synchronized, minimizing load and ensuring the contact list stays up to date.

This option is useful for performing an immediate update outside of the regular sync interval or after adjusting configuration settings.

• Erase Data: Removes the source configuration and deletes all contact data retrieved from the custom source. This includes any associated activities. A confirmation prompt is shown: "This action will delete all data related to this custom contact source, including contacts and activities related to those contacts. Are you sure you want to continue with this action?"

• Status Message: Displays information about the last sync operation, including date, time, and number of synced/deleted contacts.