Pixxi Forms & Pixxi Forms Pro – Complete Documentation

Introduction

What is Pixxi Forms?

Pixxi Forms is a WordPress plugin that connects your site to Pixxi CRM. It lets you add contact and inquiry forms via shortcodes; submissions are sent to your Pixxi CRM API with configurable field mapping. No manual copying of leads—everything syncs automatically.

What is Pixxi Forms Pro?

Pixxi Forms Pro is a premium add-on that requires the free Pixxi Forms plugin. It unlocks submission logs, country code selector on the phone field, reCAPTCHA spam protection, email notifications, webhooks, multiple API profiles, and license-based activation for your site.

Key Benefits

• Send form submissions directly to Pixxi CRM
• Listing forms that assign leads to the listing agent (property-specific)
• General forms for flexible lead capture
• Shortcodes for easy embedding in pages and posts
• Configurable field mapping and custom fields
• API token and endpoint configuration in Settings
• Pro: Submission logs – view, search, and export all entries
• Pro: Country code selector on phone field (flags + dial codes)
• Pro: reCAPTCHA v2 to reduce spam
• Pro: Email notifications to admins and optional confirmation to submitter
• Pro: Webhooks – POST form data to external URLs (Zapier, Make, etc.)
• Pro: Multiple API profiles per form
• Pro: Thank-you message or redirect after submission

Installation

Step 1: Install Pixxi Forms (Free)

1. Go to WordPress Admin → Plugins → Add New
2. Upload the pixxi-forms ZIP or install from the repository
3. Click Install Now, then Activate Plugin

Step 2: Install Pixxi Forms Pro (Optional)

1. Download the Pro plugin ZIP from your purchase or developer
2. Go to Plugins → Add New → Upload Plugin
3. Choose the Pro ZIP file and click Install Now
4. Activate Pixxi Forms Pro
5. Go to Pixxi Forms → Settings and enter your license key in the Pixxi Forms Pro License card, then click Activate

Step 3: Verify Installation

• A new menu item Pixxi Forms appears in the WordPress admin sidebar
• Submenus: Settings, Manage Forms, Field Mapping, Submission Logs (Pro), Pro Features / Upgrade to Pro
• The plugin creates database tables for forms and submissions on activation

Requirements

System Requirements

• WordPress: 5.0 or higher
• PHP: 7.4 or higher
• PHP Extensions: json, mbstring (curl recommended for API calls)
• WordPress Admin: User with manage_options capability to configure settings

Required Access

• Pixxi CRM account with API access
• API Token from Pixxi CRM (Admin → Integrations → Pixxi Forms)
• API Endpoint URL (default: https://dataapi.pixxicrm.ae/pixxiapi/webhook/v1/form)
• Pro: Valid Pixxi Forms Pro license key for your domain

Getting Started

Initial Setup

1. Go to Pixxi Forms → Settings
2. Enter your API Token and API Endpoint URL in the API Configuration card
3. Click Save Settings
4. Click Test Connection to verify the API is reachable
5. Go to Pixxi Forms → Manage Forms to create your first form

Creating Your First Form

1. Go to Pixxi Forms → Manage Forms
2. Click Add New or edit an existing form
3. Set Form name, Form ID (must match the form identifier in Pixxi CRM), and Form type (Listing or General)
4. Save the form
5. Copy the shortcode shown (e.g. [pixxi_general_form form_id="your-form-id"]) and paste it into a page or post

Configuration

API Settings

API Token

Obtain from Pixxi CRM → Admin → Integrations → Pixxi Forms. Keep this token secure and private.

API Endpoint URL

Default: https://dataapi.pixxicrm.ae/pixxiapi/webhook/v1/form

Use the URL provided by your Pixxi CRM. Form submissions are sent to this endpoint as POST requests.

Remove Data on Uninstall

When enabled, all plugin options and database tables (forms, submissions) are removed when the plugin is deleted. If disabled, data remains in the database after uninstall.

Pro: License (Pixxi Forms Pro)

In the Pixxi Forms Pro License card (Settings):

• Enter your license key (format: PIXXI-XXXX-XXXX-XXXX)
• Click Activate to activate the license for this site
• Click Deactivate to deactivate the license on this site

License status is shown below the buttons. You need an active license to use Pro features (Submission Logs, country selector, reCAPTCHA, email, webhooks, API profiles).

Pro: Country Code Selector

• Enable country code selector on phone field – When enabled, forms show a country + dial code selector for the phone field.
• Default phone country – Default country for the phone field (e.g. United Arab Emirates, Saudi Arabia).

Pro: reCAPTCHA

Configure Google reCAPTCHA v2 (“I’m not a robot” checkbox) to reduce spam. Enter Site Key and Secret Key from the Google reCAPTCHA admin, then enable reCAPTCHA. The checkbox is shown on forms when enabled.

Pro: Email Notifications

• Notify admin(s) on each submission – Send an email to one or more addresses (comma-separated). Default: site admin email.
• Send confirmation email to submitter – Optionally email the person who submitted the form.

Pro: Webhooks

Enter one URL per line. When a form is submitted, the form data is POSTed as JSON to each URL. Use for Zapier, Make, or custom endpoints.

Pro: API Profiles

Create multiple API profiles (different token/URL per profile). When editing a form in Manage Forms, you can assign an API profile so that form uses different credentials (e.g. for staging or multiple CRMs).

Shortcodes & Form Types

Listing Form

Use for property-specific inquiries. Leads are assigned to the listing agent in Pixxi CRM.

Shortcode:

[pixxi_listing_form form_id="your-form-id" property_id="property-id"]

• form_id – The Form ID from Pixxi CRM (must match the form you created in Manage Forms).
• property_id – The property ID (e.g. from Houzez or your theme). Required so the lead is linked to the correct listing.

General Form

Use for general contact or inquiry forms. Lead assignment is configured in Pixxi CRM for the form.

Shortcode:

[pixxi_general_form form_id="your-form-id"]

Optional attribute:

• show_labels=”no” – Hide field labels and show only placeholders (compact form).

[pixxi_general_form form_id="your-form-id" show_labels="no"]

Form Types Summary

Field Mapping

What is Field Mapping?

Field mapping lets you define which form fields (name, email, phone, and custom fields) are sent to Pixxi CRM and how they are labeled. You can add custom fields and mark them as required.

How to Configure

1. Go to Pixxi Forms → Field Mapping
2. Select a form from the dropdown
3. Add or edit rows: Field name (API key), Label (shown on form), Type (text, email, etc.), Required
4. Save field mappings

Standard fields (name, email, phone) are typically sent automatically; custom fields and labels are controlled here. Mappings are stored per form.

Manage Forms

Form Editor

• Form name – Internal name for the form (e.g. “Contact”, “Property Inquiry”).
• Form ID – Must match the form identifier in Pixxi CRM. Used in shortcodes.
• Form type – Listing or General.
• Pro: API profile – Optionally select an API profile for this form.
• Pro: Success type – Show a message or redirect after submission; success message text or redirect page/URL.

After saving, the shortcode is displayed so you can copy it into a page or post.

Pro Features Overview

Submission Logs

View all form submissions in one place. Search, filter, and view details. Available under Pixxi Forms → Submission Logs when Pro is active and licensed.

Country Code Selector

Phone field shows country flags and dial codes. Configure default country and enable/disable in Settings → Pro Features.

reCAPTCHA & Spam Protection

Google reCAPTCHA v2 integration. Configure Site Key and Secret in Settings and enable to show the “I’m not a robot” checkbox on forms.

Email Notifications

Notify admins (and optionally the submitter) by email when a form is submitted. Configure in Settings.

Thank-You Message & Redirect

Per-form setting: show a custom success message or redirect to a page/URL after successful submission. Set in Manage Forms when editing a form.

Webhooks

POST form data as JSON to one or more URLs (one per line). Use for Zapier, Make, or custom integrations.

Multiple API Profiles

Define multiple API credentials and assign a profile to each form. Useful for staging or multiple CRMs.

License & Pro Activation

Activating Pixxi Forms Pro

1. Install and activate the free Pixxi Forms plugin
2. Install and activate Pixxi Forms Pro
3. Go to Pixxi Forms → Settings
4. In the Pixxi Forms Pro License card, enter your license key
5. Click Activate
6. A success message confirms the license is active for this site

License Key

You receive the license key by email after purchasing Pro. Format: PIXXI-XXXX-XXXX-XXXX. The license is tied to your site URL. If you change domain, deactivate on the old site and activate on the new one (subject to your plan’s site limit).

Troubleshooting

Common Issues

Submissions not reaching Pixxi CRM

Solutions:

• Verify API Token and API Endpoint URL in Settings
• Use Test Connection to confirm the API is reachable
• Check that the Form ID in WordPress matches the form in Pixxi CRM
• Review any error message shown after submission (or check browser console / network tab)

Pro features not available

Solutions:

• Ensure Pixxi Forms Pro is installed and activated
• Activate your license in Pixxi Forms → Settings (Pixxi Forms Pro License card)
• Check that the license status shows “Active for this site”

reCAPTCHA not showing / errors

Solutions:

• Confirm reCAPTCHA is enabled in Settings and Site Key is set
• Use reCAPTCHA v2 “I’m not a robot” keys (not v3 only, unless the plugin supports it)
• Check that your domain is allowed in the Google reCAPTCHA admin console

Debug Mode

Enable WordPress debug logging in wp-config.php:

define('WP_DEBUG', true);
define('WP_DEBUG_LOG', true);
define('WP_DEBUG_DISPLAY', false);

Check logs at wp-content/debug.log for API or PHP errors.

FAQ

Where do I get the API token?

From Pixxi CRM: Admin → Integrations → Pixxi Forms.

What is the Form ID?

The Form ID is the identifier for the form in Pixxi CRM. You create a form in Pixxi CRM and use that same ID in Pixxi Forms → Manage Forms and in the shortcode (form_id="...").

Can I use different API credentials per form?

Yes, with Pro. Create API profiles in Settings and assign a profile to each form in Manage Forms.

Do you store submission data?

Submission data is sent to the Pixxi CRM API you configure. With Pro, submissions are also stored locally for the Submission Logs feature. The plugin does not send data to the plugin author’s servers; only to your API endpoint.

How do I show a thank-you message or redirect after submit?

With Pro, when editing a form in Manage Forms you can set Success type to “Message” (with custom text) or “Redirect” (to a page or URL).

Support

Getting Help

• Review this documentation first
• Check the Troubleshooting and FAQ sections
• Verify API credentials and license (for Pro)
• Check WordPress debug log for errors

Additional Resources

• Plugin URI: https://devmizan.com/plugins/pixxi-forms/
• Author: Dev Mizan
• Pixxi Forms (free): Required base plugin
• Pixxi Forms Pro: Premium add-on; purchase and license activation from the plugin site