Contact Form 7 CiviCRM integration

by Jaap Jansma

Description

This plugin adds integration for CiviCRM to Contact Form 7. With this plugin it is possible to submit a contact to a local or remote CiviCRM system.

This adds a CiviCRM tab to Contact Form confgurations. If you enable CiviCRM processing the form will be submitted to the CiviCRM API v3. For information about using CiviCRM’s API see https://docs.civicrm.org/dev/en/latest/api/

The API requires an Entity and an Action. You may need to add additional parameters depending for the Entity/Action you specify. Use the API Explorer on your CiviCRM system to determine what additional parameters are required. The form parameters will automatically be included in the API call and the form variables need to match those expected by the API.
For example, if the API call needs a field called first_name then your form template should have a field called first_name (not first-name or firstName etc)

Installation

Upload the plugin files to the /wp-content/plugins/plugin-name directory, or install the plugin through the WordPress plugins screen directly.
Activate the plugin through the ‘Plugins’ screen in WordPress
Use the Settings > CiviCRM Contact Form 7 Settings screen to configure the plugin, or follow the Settings link from the plugins page
Enable CiviCRM on each CF7 form.

Screenshots

This screenshot shows the settings screen, using the traditional extern/rest.php endpoint
This screenshot shows the screen for enabling and setting up CiviCRM integration on a contact form.
This screenshot shows the settings screen, using the modern civicrm/ajax/rest endpoint (note no trailing slash for the server and no leading slash for the path)

Reviews

Poor requires documentation

By phillalf on February 12, 2025

They hint that you need to set various fields but dont let tell what the are. So the example they give doesnt work.
It requires documentation that shows a correctly developed from along with the required CiviCrm settings

Works brilliantly when it works. Docs and debug fairly poor.

By Phil McKerracher on June 28, 2022

Since I got this working (with some quick and helpful advice from the author) it has worked very well. I love the flexibility of the API/form processor approach, which basically lets you do anything API v3 can do. The functionality is better than the Caldera Forms it replaced and it's free! The catch is it's really quite difficult to set up because the documentation is incomplete and debugging is difficult (the "API REST Log" extension in CiviCRM looks useful but I couldn't get it to work). The two big "gotchas" that caught me were the example CiviCRM path was wrong for WordPress (should be wp-json/civicrm/v3/rest) and the names of the form fields must match the entity names in the API, some of which (custom fields) are quite hard to discover. The problem is, there are a lot of things you have to get right (paths, permissions, API keys, variable names, API and PHP versions) and there are so many permutations of all of these that if it doesn't work you can spend days and days googling for clues and tearing hair out.

Changelog

1.10

Fix https://wordpress.org/support/topic/civicrm-processing-cant-be-disabled-with-fix/

1.9

Fix for WordPress 5.8

1.8

Fix for validation when no local CiviCRM

1.7

Added validation to settings page
Added link to settings from plugins page

1.6

Updated readme

1.5

Updated readme

1.4

Updated text domain

1.3

Updated data handling and added a path for the civicrm installation

1.2

Updated readme

1.1

Changed text domain

1.0

Initial commit