Card configuration options

Many ThoughtFarmer custom cards feature flexible configuration parameters that allow administrators to customize card behavior, data sources, and visual outputs without modifying the underlying source code. These settings are defined using JavaScript Object Notation (JSON).

Because JSON requires strict syntax, minor formatting mistakes—such as a missing quotation mark or an trailing comma—will cause parsing errors and prevent the card from rendering properly. This guide outlines how card configuration works and how to resolve common syntax errors.

Where to configure card options

Card configuration options are passed into the card's execution scope via the Details tab within the card editor interface (Admin panel > Custom cards).

Depending on your operational requirements, card options can be managed in one of two ways:

1. Global default configuration

• Usage: Configured directly within the admin panel card editor.

• Behavior: Every new instance of the card added to any page across the intranet will automatically inherit these default settings.

2. Per-instance configuration

• Usage: Enable the Allow card configuration on edit page checkbox on the card's Details tab.

• Behavior: New instances of the card will still receive the global default configuration initially. However, page editors can override these settings for a specific page instance by clicking the Gear (Settings) icon on the card within the page template editor.

Valid JSON configuration structure

All card parameters must be formatted as valid JSON object key-value pairs. Each parameter name and value must follow strict formatting rules:

{
  "customTitle": "My Chosen Custom Title",
  "winnerPoints": 50,
  "endDate": "2026-08-13"
}

Common JSON configuration errors

Review this checklist to identify and correct syntax errors in your card configuration payload:

1. Missing outer curly braces { }

The entire configuration payload must be wrapped in opening { and closing } curly braces.

• Invalid: "customTitle": "Header"

• Valid: { "customTitle": "Header" }

2. Missing or incorrect quotation marks

All parameter names (keys) and string values must be enclosed in standard double quotation marks ("). Do not use single quotes (') or smart/curly quotes (“ ”).

• Invalid: { customTitle: 'Header' }

• Valid: { "customTitle": "Header" }

• Note: Numeric values (e.g., 25) and boolean values (true/false) do not require quotation marks unless specified by the card developer.

3. Missing or misplaced colons :

A single colon must separate each parameter name from its corresponding value.

• Invalid: { "winnerPoints" 50 }

• Valid: { "winnerPoints": 50 }

   

4. Incorrect parameter key names or casing

JSON keys are strictly case-sensitive. Ensure the key names match the documentation in the Custom Card Marketplace or the developer specification notes exactly.

• Invalid: { "customtitle": "Header" }

• Valid: { "customTitle": "Header" }

5. Invalid date string formatting

If a card parameter requires a date, it must strictly adhere to the standard YYYY-MM-DD ISO format (or the specific string format required by the card developer).

• Invalid: { "endDate": "08/13/2026" }

• Valid: { "endDate": "2026-08-13" }

   

6. Trailing or missing commas

Separate each key-value pair with a comma ,. Do not place a comma after the final key-value pair before the closing curly brace }.

{
  "bronze": 25,
  "customTitle": "My Chosen Title",
  "customArray": [325, 235, 2356],
  "endDate": "2026-08-13" 
}

(Notice there is no comma after "2026-08-13").

Getting further support

If you have verified your JSON formatting against the syntax checklist above and your card continues to return parsing errors, please open a ticket with the ThoughtFarmer Helpdesk for engineering assistance. Be sure to include your exact JSON configuration payload and the card name in your ticket submission.