README

A Realsuite integration that extends the Formie plugin for Craft CMS. Pushes Formie form submissions to the Realsuite SiteSync API as leads.

Requirements

This plugin requires:

• Craft CMS 5.0.0 or later
• PHP 8.2 or later
• Formie 3.0 or later
• A Realsuite account with a SiteSync API key

Installation

With Composer

Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require esign/craft-formie-realsuite

# tell Craft to install the plugin
./craft plugin/install formie-realsuite

From the Plugin Store

Go to the Plugin Store in your project's Control Panel and search for "Formie Realsuite Integration". Then press "Install".

Usage

Setting Up the Realsuite Integration

1. Navigate to Formie → Settings → CRM
2. Click New Integration
3. Select Realsuite as your integration provider
4. Enter your Realsuite SiteSync API Key and save the integration
5. After saving, click the Refresh button in the right-hand sidebar to verify the API connection

Sending Form Submissions to Realsuite

1. Go to the form you want to connect with Realsuite
2. Navigate to the Integrations tab
3. Enable your Realsuite integration
4. Toggle one or more lead types and map your form fields:

1. Map each form field to the corresponding Realsuite field and save the form

Field Mapping Notes

• Lead Detail — publicationId and lastName and info are required
• Lead Estimate — lastName is required; address and estate type fields are optional
• Lead Info — lastName is required
• Lead Search Profile — lastName is required; the searchProfile object is assembled automatically from the Search Profile:, Residential:, and Professional: prefixed fields
• Array fields (Search Profile: Sorts, Genres, Characterisations, Zipcodes) — map these to a Formie Checkboxes or Multi-select Dropdown field to pass multiple values

Custom Value Transformations

If you need to transform field values before they are sent to Realsuite (e.g. mapping a Craft entry selection to a Realsuite string code), listen to the EVENT_MODIFY_FIELD_MAPPING_VALUE event in a project module:

use esign\formierealsuite\integrations\crm\Realsuite;
use verbb\formie\events\ModifyFieldIntegrationValueEvent;

Event::on(
    Realsuite::class,
    Realsuite::EVENT_MODIFY_FIELD_MAPPING_VALUE,
    function(ModifyFieldIntegrationValueEvent $event) {
        // $event->value    — the value being sent (modify this)
        // $event->rawValue — the original unmodified value
        // $event->field    — the Formie form field
        // $event->integrationField — the Realsuite destination field
    }
);

API Documentation

For more information about the Realsuite SiteSync API, refer to the Realsuite SiteSync API documentation.

License

This plugin is licensed under the MIT License. Please see License File for more information.

Screenshot