Navigation: Spark CRM > Settings
API Connection
Auth Token
Your SparkCRM API authentication token. Generate one in your SparkCRM account under Settings > API Tokens.
- Go to Spark CRM > Settings in WordPress admin
- Enter your Auth Token
- Click Save Settings
The token is encrypted and stored securely using AES-256-CBC encryption with your WordPress authentication salt.
Campaign ID
The numeric ID of the SparkCRM campaign this store should send orders to.
- In SparkCRM, open Campaigns in the sidebar and read the value in the ID column for your campaign — this is the campaign’s numeric internal ID. (The ID in the campaign page URL is a UUID and will not work here.)
- Enter the Campaign ID in the plugin settings
- Click Save Settings
Test Connection
Click the Test Connection button to verify your API credentials. The plugin will attempt to fetch your campaigns from SparkCRM and report the result.
Debug Mode
Enable debug logging to capture detailed API request and response data in the WordPress error log.
Debug logs include:
- Request data (customer info, products, payment details)
- API responses and status codes
- Error messages and validation failures
Important: Never enable Debug Mode on a production site. The request payload is logged without redaction, so any checkout completed while it is on writes the customer’s full card number and CVV to the WordPress error log. Reproduce the issue on a staging site using test cards instead.
Payment Gateway
The Spark payment gateway allows customers to pay directly through SparkCRM from WooCommerce checkout.
Enabling the Gateway
- Go to WooCommerce > Settings > Payments
- Find Spark CRM in the payment methods list
- Toggle it to Enabled
- Click Manage to configure gateway-specific settings
Gateway Settings
| Setting | Description |
|---|---|
| Enable/Disable | Toggle the payment gateway on or off |
| Title | Payment method name shown to customers (default: “Credit Card (Spark CRM)”) |
| Description | Description shown on checkout (default: “Pay securely with your credit or debit card”) |
How It Works
- Customer enters card details on the WooCommerce checkout page
- The plugin sends the order to SparkCRM’s
/checkout/ordersendpoint - SparkCRM processes the payment and returns the result
- On success, the WooCommerce order is marked as paid with the SparkCRM transaction ID
Settings Summary
| Setting | Location | Description |
|---|---|---|
| Auth Token | Spark CRM > Settings | API authentication token |
| Campaign ID | Spark CRM > Settings | Campaign to send orders to |
| Debug Mode | Spark CRM > Settings | Enable API request/response logging |
| Payment Gateway | WooCommerce > Settings > Payments | Enable Spark CRM as a payment method |
| Product Mapping | Spark CRM > Product Mapping | Map each WooCommerce product to a campaign offer ID — required, see Product Mapping |
| Webhooks | Spark CRM > Webhooks | Inbound sync from SparkCRM, see Webhooks |
An order containing no mapped products is rejected with “No products mapped to Spark CRM offers”, so complete Product Mapping before enabling the gateway on a live store.