Skip to main content

Integrating Fluent Forms with SendSquared Lead API

warning

IMPORTANT: Before implementing this integration, you will need to gather specific information from both Fluent Forms and SendSquared. Please use the checklist below to ensure you have all required information before you begin.

Implementation Checklist​

Copy this checklist to your task management system to track your progress:

  • Fluent Forms: Identify your form field names/IDs
  • Fluent Forms: Identify your form ID
  • Fluent Forms: Test your form submission
  • SendSquared: Obtain your API key
  • SendSquared: Determine the lead type ID to use
  • SendSquared: Determine the lead status ID to use
  • SendSquared: Identify the user ID for lead assignment
  • SendSquared: Determine the source ID (if applicable)
  • Test the integration after implementation

The following code integrates Fluent Forms with SendSquared's Lead With Contact API. When a form is submitted, it collects form data, constructs the necessary contact and lead information, and sends it to SendSquared. This allows you to automatically create leads in your SendSquared CRM directly from form submissions on your WordPress site.

note

You must update the form ID, field names, and API-related IDs with your specific values. See the comments in the code for details on what needs to be updated.

<?php
add_action('fluentform/submission_inserted', 'send_fluent_forms_data_to_sendsquared', 10, 3);

function send_fluent_forms_data_to_sendsquared($entryId, $formData, $form)
{
  // Only run this for a specific form ID - update with your form ID
  if ($form->id != 5) {
    return;
  }
  
  // Get the submitted form data - update these field names with your actual Fluent Forms field names
  $email = isset($formData['email']) ? $formData['email'] : '';
  $first_name = isset($formData['first_name']) ? $formData['first_name'] : '';
  $last_name = isset($formData['last_name']) ? $formData['last_name'] : '';
  $phone = isset($formData['phone']) ? $formData['phone'] : ''; // must be in E.164 format
  $interest_in = isset($formData['interest']) ? $formData['interest'] : '';
  $other_items = isset($formData['message']) ? $formData['message'] : '';
  
  // This constructs the subject line using the interest field
  $subject = 'Interested in ' . $interest_in;
  $now = new DateTime(); 
  $formatted_now = $now->format(DateTime::ATOM);

  // Contact data structure
  $contactData = array(
    'email' => $email,
    'first_name' => $first_name,
    'last_name' => $last_name,
    'mobile_phone' => $phone, // must be in E.164 format (+1XXXXXXXXXX)
  );

  // Lead data structure
  $leadData = array(
    // Update these IDs with your actual SendSquared IDs
    'lead_type_id' => 116, // Update with your lead type ID
    'lead_status_id' => 504, // Update with your lead status ID
    'subject' => $subject,
    'interest_start_at' => $formatted_now,
    'interest_end_at' => $formatted_now,
    'quantity_1' => 1, // Number of adults - customize as needed
    'quantity_2' => 0, // Number of children - customize as needed
    'notes' => array($other_items),
    'user_id' => 1446, // Update with your agent user ID
    'source_id' => 0,  // Update with your source ID if needed
  );

  // Prepare request data
  $requestData = json_encode(array(
    'contact' => $contactData,
    'lead' => $leadData,
  ));

  // Send data to the SendSquared API
  $response = wp_remote_post('https://api.sendsquared.com/v1/leads/lead-with-contact', array(
    'method' => 'POST',
    'headers' => array(
      'Content-Type' => 'application/json',
      // Update with your actual API key
      'x-api-key' => 'your-api-key-here',
    ),
    'body' => $requestData,
  ));

  // Error handling
  if (is_wp_error($response) || wp_remote_retrieve_response_code($response) != 200) {
    $response_code = wp_remote_retrieve_response_code($response);
    $response_body = wp_remote_retrieve_body($response);
    error_log("Error submitting lead to SendSquared (Code: {$response_code}): " . $response_body);
  }
}

Gathering Required Information​

Before implementing this integration, you'll need to gather information from both Fluent Forms and SendSquared:

From Fluent Forms:​

  1. Form ID: In Fluent Forms, each form has a unique ID:

    • Go to Fluent Forms > All Forms in your WordPress admin
    • Look for the ID column to find your form ID

  2. Field Names: In Fluent Forms, each field has a name/ID. To find your field names:

    • Go to Fluent Forms > All Forms in your WordPress admin
    • Edit your form
    • Click on each field and look at the "Admin Field Label" or "Element Name" in the right panel
    • Note down the names for these fields:
      • Email field
      • First name field
      • Last name field
      • Phone field
      • Interest field
      • Message/notes field

From SendSquared:​

  1. API Key: Go to Settings > API Keys in your SendSquared admin panel to obtain your API key
  2. Lead Type ID: Navigate to Settings > Lead Types and note the ID of the appropriate lead type
  3. Lead Status ID: Go to Settings > Lead Statuses and identify the status ID you want to use for new leads
  4. User ID: This is the ID of the agent who will be assigned these leads. You can find user IDs in the Users section
  5. Source ID: If you track lead sources in SendSquared, obtain the appropriate source ID from Settings > Sources

All of these IDs are required for the integration to work properly. If you're unsure about any of these values, contact SendSquared support for assistance in locating them in your account.

Implementation Steps​

  1. Copy the code snippet above
  2. Paste it into your theme's functions.php file or in a custom plugin
  3. Update the form ID ($form->id != 5) with your actual Fluent Forms form ID
  4. Update all the field names to match your Fluent Forms field names:
    • email
    • first_name
    • last_name
    • phone
    • interest
    • message
  5. Update the SendSquared specific IDs that you gathered earlier:
    • lead_type_id
    • lead_status_id
    • user_id
    • source_id
  6. Replace your-api-key-here with your actual SendSquared API key
  7. Test your form submission to ensure leads are being created in SendSquared

Understanding Fluent Forms Data Structure​

The integration uses the fluentform/submission_inserted hook which is triggered after a form is successfully submitted. Fluent Forms provides three parameters to this hook:

  1. $entryId - The ID of the newly created entry
  2. $formData - An associative array containing the submitted form data
  3. $form - The form object containing form information including the form ID

The $formData array contains the submitted values where the keys are the field names or IDs defined in your form. For example:

$formData = [
  'email' => 'user@example.com',
  'first_name' => 'John',
  'last_name' => 'Doe',
  'phone' => '+12345678900',
  'interest' => 'Property Management',
  'message' => 'I would like more information about your services.'
];

In the integration code, we access these values directly using the field names.

Understanding the Lead With Contact API​

The SendSquared Lead With Contact API creates both a contact record and a lead record in a single API call, linking them together automatically. This is useful when:

  • You want to capture new leads from your website
  • You need to track interest in specific properties or services
  • You want to automate the lead capture process

Customizing the Lead Data​

You can customize various aspects of the lead data to fit your specific needs:

// Example of additional lead customization
$leadData = array(
  'lead_type_id' => 116,
  'lead_status_id' => 504,
  'subject' => $subject,
  'interest_start_at' => $formatted_now,
  'interest_end_at' => $formatted_now,
  'quantity_1' => isset($formData['adults']) ? intval($formData['adults']) : 1,
  'quantity_2' => isset($formData['children']) ? intval($formData['children']) : 0,
  'notes' => array(
    "Interest: " . $interest_in,
    "Budget: " . (isset($formData['budget']) ? $formData['budget'] : ''),
    "Additional notes: " . $other_items
  ),
  'user_id' => 1446, // The agent who will handle this lead
  'source_id' => 123, // Your website source ID
);

Troubleshooting​

If your integration isn't working properly, check these common issues:

  1. Verify that your Fluent Forms form ID and field names match exactly what you've specified in the code
  2. Confirm that your SendSquared API key is correct
  3. Check your WordPress error logs for any API errors
  4. Pay attention to response codes from the SendSquared API:
    • 422 Error: This means validation failed. The response body will contain details about what is missing or incorrect in your request. Check field formats (especially the phone number which must be in E.164 format) and required fields.
  5. Ensure that WordPress can make outgoing HTTP requests (some hosting providers block these)
  6. Verify that the SendSquared API endpoint is accessible from your server

To debug Fluent Forms submissions, you can add this code temporarily to see the structure of your form data:

add_action('fluentform/submission_inserted', 'debug_fluent_forms_submission', 10, 3);
function debug_fluent_forms_submission($entryId, $formData, $form) {
  error_log('Fluent Forms Submission - Entry ID: ' . $entryId);
  error_log('Fluent Forms Submission - Form Data: ' . print_r($formData, true));
  error_log('Fluent Forms Submission - Form ID: ' . $form->id);
}

For additional support, contact SendSquared support at or +1.855.340.7363.