Download the PHP package wazza/sync-model-to-crm without Composer

Sync Model to CRM

Easily synchronize your Laravel Eloquent models with remote CRM providers such as HubSpot, Pipedrive, and more. This package allows you to define which model properties and relationships should be kept in sync with external CRM objects, providing a seamless integration experience.

Features

• Flexible Property Mapping: Define which model attributes map to CRM fields.
• Multi-Environment Support: Sync to multiple CRM environments (e.g., sandbox, production).
• Relationship Sync: Automatically associate related models (e.g., User to Company).
• Customizable Sync Triggers: Initiate syncs via observers, mutators, or queued jobs.
• Extensible: Easily add support for additional CRM providers.

Supported CRMs

• HubSpot
  • Sync User model to HubSpot Contact object.
  • Sync Entity model to HubSpot Company object.
  • Manage associations between Contact and Company.
  • (Coming soon) Support for Deal and Ticket objects.
• Planned Support
  • Pipedrive
  • Salesforce
  • Zoho CRM
  • Others

Requirements

• PHP: 8.2 or higher
• Laravel: 12.x

How It Works

Define a set of properties on your Eloquent models to control how and when they sync with your CRM provider. After the first successful sync, the CRM object’s primary key is stored in a mapping table for efficient future updates.

Required Model Properties

Add the following properties to your model to enable CRM synchronization:

Example: User Model

Below is a sample User model configured for CRM synchronization:

Usage

You can trigger a model sync in several ways:

1. Using the ShouldSyncToCrmOnSave (Automatic Sync on Save): Add the ShouldSyncToCrmOnSave to your Eloquent model to automatically trigger a CRM sync every time the model is saved (created or updated). This is the easiest way to ensure your model stays in sync with your CRM provider without writing custom logic.

   When to use:

   • Use ShouldSyncToCrmOnSave if you want your model to always sync to the CRM automatically after every save (create/update), with no extra code required.
   • This is ideal for most use cases where you want seamless, automatic syncing.

2. Using the HasCrmSync (Manual or Custom Sync): Add the HasCrmSync to your model if you want to control exactly when the sync happens. This trait provides methods like $this->syncToCrm(), $this->syncToCrmCreate(), $this->syncToCrmUpdate(), etc., which you can call from mutators, custom methods, or anywhere in your application.

   When to use:

   • Use HasCrmSync if you want to trigger syncs only at specific times, or if you need to customize the sync logic (e.g., only sync on certain conditions, or from a controller, observer, or job).
   • This is ideal for advanced use cases or when you want more granular control over syncing.

3. Directly in a Controller:

   Note: Instantiating with new CrmSyncController() will always create a new instance, bypassing the singleton. To use the singleton, always resolve it from the container.

4. Via an Observer: Register an observer to automatically sync after save, update, delete, or restore events.

5. In a Job: Offload sync logic to a queued job for asynchronous processing.

Installation

1. Install via Composer:

2. Register the Service Provider (if not auto-discovered): Add to bootstrap/providers.php:

   If your package supports Laravel auto-discovery, this step may be optional.

3. Publish Config and Migrations:

4. Configure Environment Variables: Add the following to your .env file (see config/sync_modeltocrm.php for details):

5. Cache Config:

6. Review Configuration: Adjust the published config file as needed. You also do not need all of the env settings above, have a look at the config file and overwrite any applicable items. Happy coding 😉

Monitoring & Logs

Set your desired log level in the config file (1 = high, 3 = low verbosity). Monitor sync activity in your Laravel log file:

Testing

We have included a few unit tests, please expand if you wish to fork and help expand the functionalities.

Example output:

More tests and features coming soon!

License

This project is open-sourced under the MIT license.