Update create-form.mjs #18304
Update create-form.mjs #18304
Conversation
Added a thorough and complete description of the fieldGroups parameter
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
WalkthroughExpanded the in-file description for fieldGroups in components/hubspot/actions/create-form/create-form.mjs to a comprehensive, multi-line template string detailing structures, types, validations, dependencies, examples, and notes. No logic, API, or control-flow changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified. |
|
Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
components/hubspot/actions/create-form/create-form.mjs (3)
115-121: Tighten notes; avoid absolute requirements tied to earlier speculative parts.- - ALL field properties listed as required MUST be included, even if empty - - Hidden dependent fields should have `"hidden": true` initially + - Include only properties required by the API for your selected `fieldType`. + - If using conditional fields, ensure your account/API version supports them.
30-123: Consider replacing with a concise, safe description + doc link.The current block is very long and risks drifting from the upstream API. A shorter, accurate description reduces support load.
- description: `Array of stringified JSON objects defining form field groups. Each string must contain a complete field group object. - ... - [See the documentation](https://developers.hubspot.com/docs/reference/api/marketing/forms#post-%2Fmarketing%2Fv3%2Fforms%2F) for additional details.`, + description: `Array of stringified JSON objects, one per field group. Each item should be a JSON string representing a field group with its fields. + + How to use: + - Add one item per field group (paste a single-line JSON string). + - Field shapes and allowed values depend on HubSpot Forms v3. + - Example (one item): + "{\"groupType\":\"default_group\",\"fields\":[{\"objectTypeId\":\"0-1\",\"name\":\"email\",\"label\":\"Email\",\"fieldType\":\"email\",\"required\":true}]}" + + Important: + - Only include properties required for your chosen field types. + - For the full schema and latest enums, see HubSpot Forms API docs.`,
76-92: Remove incorrect validation examples and reference HubSpot Property Validations API
The example keys (min,max,decimals,minDate,maxDate,allowedExtensions,maxFileSize) don’t match the API’s ruleType values (e.g., MIN_NUMBER/MAX_NUMBER, MIN_LENGTH/MAX_LENGTH, REGEX, ALPHANUMERIC, etc.) or file‐upload behavior. Replace the hardcoded snippets with a generic note pointing to the Property Validations API docs for exact keys per fieldType.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/hubspot/actions/create-form/create-form.mjs(1 hunks)
🔇 Additional comments (3)
components/hubspot/actions/create-form/create-form.mjs (3)
394-394: Sanity check: parseObject(fieldGroups) expectations.Given the new guidance, confirm parseObject accepts string[] of JSON objects and returns an array of objects (no nested arrays). If it also accepts a single JSON string that is an array, document that.
Would you like me to trace parseObject in common/utils.mjs and confirm accepted shapes?
34-37: Enums align with HubSpot Forms v3 API
The values forgroupType("default_group","progressive","queued") andrichTextType("text","image") match the official API and are required.
56-75: Align fieldType names and option requirements with HubSpot API
components/hubspot/actions/create-form/create-form.mjs (56–75)-*Selection Types (require `options` array):* -- `"dropdown"` – Dropdown menu. Add: `"options": …` -- `"radio"` – Radio buttons. Add: `"options": …` -- `"multiple_checkboxes"` – Multiple checkboxes. Add: `"options": …` -- `"single_checkbox"` – Single checkbox -- `"payment_link_radio"` – Payment options +*Selection Types (require `options` array):* +- `"select"` – Enumeration field (requires `options`) +- `"radio"` – Enumeration field (requires `options`) +- `"checkbox"` – Enumeration field (requires `options`) + +*Boolean Input:* +- `"booleancheckbox"` – Single checkbox (no `options`)Likely an incorrect or invalid review comment.
| - \`objectTypeId\` (string, required) - CRM object type: "0-1" (Contact), "0-2" (Company), "0-3" (Deal), "0-5" (Ticket) | ||
| - \`name\` (string, required) - Unique field identifier (e.g., "email", "firstname", "company") | ||
| - \`label\` (string, required) - Display label for the field | ||
| - \`fieldType\` (string, required) - Field type (see FIELD TYPES below) | ||
| - \`required\` (boolean, required) - Whether field must be filled | ||
| - \`hidden\` (boolean, required) - Whether field is visible (hidden fields can still pass values) | ||
| - \`validation\` (object, required) - Validation rules (can be empty object \`{}\` if no validation needed) | ||
| - \`dependentFields\` (array, required) - Conditional logic array (can be empty \`[]\` if no dependencies) | ||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Overstated “required” properties for fields.
Marking hidden, validation, and dependentFields as required is risky—they may be optional/defaulted. Over-specifying will cause user confusion.
Apply this wording tweak in the description (no behavior change):
- Each field in the `fields` array MUST include ALL of these properties:
+ Each field in the `fields` array typically includes:
@@
- - `required` (boolean, required) - Whether field must be filled
- - `hidden` (boolean, required) - Whether field is visible (hidden fields can still pass values)
- - `validation` (object, required) - Validation rules (can be empty object `{}` if no validation needed)
- - `dependentFields` (array, required) - Conditional logic array (can be empty `[]` if no dependencies)
+ - `required` (boolean, optional) - Whether field must be filled
+ - `hidden` (boolean, optional) - Whether field is visible (hidden fields can still pass values)
+ - `validation` (object, optional) - Validation rules
+ - `dependentFields` (array, optional) - Conditional logic array🌐 Web query:
Does HubSpot require `hidden`, `validation`, and `dependentFields` on each field object for the Forms v3 Create Form endpoint, or are they optional?
💡 Result:
They're optional. The Create Form (marketing/v3/forms) schema shows fields like hidden, validation and dependentFields on field objects but they are not required for every field — the docs/examples treat them as optional properties. [1][2].
References:
- Create a form (request body schema includes hidden, validation, dependentFields as properties in examples). [1]
- HubSpot API client field model docs show many field properties (e.g., defaultValue, description, placeholder) as optional; hidden/required/dependentFields appear as properties rather than required constraints. [2]
Mark optional properties as optional in the Create Form docs.
- Each field in the `fields` array MUST include ALL of these properties:
+ Each field in the `fields` array typically includes:
@@
- - `required` (boolean, required) - Whether field must be filled
- - `hidden` (boolean, required) - Whether field is visible (hidden fields can still pass values)
- - `validation` (object, required) - Validation rules (can be empty object `{}` if no validation needed)
- - `dependentFields` (array, required) - Conditional logic array (can be empty `[]` if no dependencies)
+ - `required` (boolean, optional) - Whether field must be filled
+ - `hidden` (boolean, optional) - Whether field is visible (hidden fields can still pass values)
+ - `validation` (object, optional) - Validation rules
+ - `dependentFields` (array, optional) - Conditional logic array📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - \`objectTypeId\` (string, required) - CRM object type: "0-1" (Contact), "0-2" (Company), "0-3" (Deal), "0-5" (Ticket) | |
| - \`name\` (string, required) - Unique field identifier (e.g., "email", "firstname", "company") | |
| - \`label\` (string, required) - Display label for the field | |
| - \`fieldType\` (string, required) - Field type (see FIELD TYPES below) | |
| - \`required\` (boolean, required) - Whether field must be filled | |
| - \`hidden\` (boolean, required) - Whether field is visible (hidden fields can still pass values) | |
| - \`validation\` (object, required) - Validation rules (can be empty object \`{}\` if no validation needed) | |
| - \`dependentFields\` (array, required) - Conditional logic array (can be empty \`[]\` if no dependencies) | |
| Each field in the `fields` array typically includes: | |
| - `objectTypeId` (string, required) - CRM object type: "0-1" (Contact), "0-2" (Company), "0-3" (Deal), "0-5" (Ticket) | |
| - `name` (string, required) - Unique field identifier (e.g., "email", "firstname", "company") | |
| - `label` (string, required) - Display label for the field | |
| - `fieldType` (string, required) - Field type (see FIELD TYPES below) | |
| - `required` (boolean, optional) - Whether field must be filled | |
| - `hidden` (boolean, optional) - Whether field is visible (hidden fields can still pass values) | |
| - `validation` (object, optional) - Validation rules | |
| - `dependentFields` (array, optional) - Conditional logic array |
🤖 Prompt for AI Agents
In components/hubspot/actions/create-form/create-form.mjs around lines 41 to 49,
the docs list several properties as required when some are actually optional;
update the descriptions to mark validation and dependentFields as optional (they
can be omitted or empty), and mark hidden as optional if it can be omitted,
leaving objectTypeId, name, label, and fieldType as required; adjust the text to
explicitly state "(optional)" for those properties and that they may be omitted
or provided as empty objects/arrays where applicable.
| **DEPENDENT FIELDS STRUCTURE:** | ||
| Each dependent field object in \`dependentFields\` array: | ||
| \`{ | ||
| "fieldName": "targetFieldName", // Field to show/hide | ||
| "objectTypeId": "0-1", // Object type of dependent field | ||
| "controllingValue": "specificValue", // Value that triggers condition | ||
| "condition": "EQUAL", // Condition type (see below) | ||
| "active": true // Whether dependency is active | ||
| }\` | ||
| **CONDITION TYPES:** | ||
| - \`"EQUAL"\`, \`"NOT_EQUAL"\` - Exact match conditions | ||
| - \`"CONTAINS"\`, \`"NOT_CONTAINS"\` - Text contains conditions | ||
| - \`"IS_EMPTY"\`, \`"IS_NOT_EMPTY"\` - Presence conditions | ||
| - \`"GREATER_THAN"\`, \`"LESS_THAN"\` - Numeric comparisons | ||
| - \`"CHECKED"\`, \`"NOT_CHECKED"\` - Checkbox states | ||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Dependent fields structure and condition enums look speculative.
Before documenting a structure with condition enums (EQUAL, CONTAINS, etc.), confirm the API supports it on create. Otherwise, remove or clearly mark as illustrative.
- **DEPENDENT FIELDS STRUCTURE:**
- ...
- **CONDITION TYPES:**
- - `"EQUAL"`, `"NOT_EQUAL"` ...
+ (Dependent field visibility/conditional logic may be configured in HubSpot UI and not fully supported via this endpoint. Verify before documenting.)🌐 Web query:
Does the HubSpot Forms v3 Create Form API support configuring dependent/conditional fields? If yes, what is the exact schema and allowed condition values?
💡 Result:
Short answer: Yes — the Forms API (v3) supports dependent/conditional fields via a field-level dependentFields array. See HubSpot's Forms API docs and the generated models for the exact schema and operators. [1][2][3]
What to use / where to look
- The Marketing Forms reference (v3) describes form creation and that fields can include dependent/conditional configuration. [1]
- The CMS "Module and theme fields" docs show the same visibility/conditional model and list the conditional operators supported for visibility rules (EQUAL, NOT_EQUAL, EMPTY, NOT_EMPTY, MATCHES_REGEX — plus MATCH/regex semantics and an advanced boolean_operator = AND|OR for multiple criteria). Use this page for the exact operator names and semantics. [2]
- HubSpot’s generated Forms models (official client code / docs) show the exact request model names used by v3: fields have a dependentFields array, and there is a DependentField / DependentFieldFilter model to describe the controlling field and the filter values. Inspect the generated model docs for the concrete JSON property names (DependentField, DependentFieldFilter, dependentFields). [3]
References
- HubSpot Marketing API — Forms (v3) (create/update form endpoints). [1]
- Module & theme fields — visibility / advanced_visibility and allowed operators (EQUAL, NOT_EQUAL, EMPTY, NOT_EMPTY, MATCHES_REGEX; boolean_operator = AND|OR). [2]
- Generated Forms models (shows DependentField and DependentFieldFilter in the v3 client code). [3]
If you want, I can paste an exact JSON example for a v3 Create Form body including a dependentFields block (using the exact property names from the generated model) — tell me which field types and condition you want and I’ll produce a ready-to-send payload.
Use HubSpot’s exact dependentFields schema and operators
Replace the speculative “DEPENDENT FIELDS STRUCTURE” snippet with the real v3 Forms API model:
- fields[].dependentFields: array of DependentField objects
- controllingField (string)
- filters: array of DependentFieldFilter, each with
- operator: one of EQUAL, NOT_EQUAL, EMPTY, NOT_EMPTY, MATCHES_REGEX
- values: string[] (or regex)
- boolean_operator: AND | OR (for multi-filter rules)
Provide a JSON example matching the official model.
🤖 Prompt for AI Agents
In components/hubspot/actions/create-form/create-form.mjs around lines 93 to
109, replace the speculative "DEPENDENT FIELDS STRUCTURE" block with HubSpot
Forms API v3's actual dependentFields model: use fields[].dependentFields where
each DependentField has controllingField (string), filters (array of
DependentFieldFilter) with operator (EQUAL, NOT_EQUAL, EMPTY, NOT_EMPTY,
MATCHES_REGEX), values (string[] or regex string), and a boolean_operator (AND |
OR) for combining filters; update any property names (e.g., fieldName →
controllingField, condition → operator, controllingValue → values) and valid
operator list accordingly, and include a JSON example that follows that exact
schema (showing controllingField, filters array with operator and values, and
boolean_operator).
| **COMPLETE EXAMPLE:** | ||
| \`[ | ||
| "{\"groupType\":\"default_group\",\"richTextType\":\"text\",\"richText\":\"<h3>Contact Info</h3>\",\"fields\":[{\"objectTypeId\":\"0-1\",\"name\":\"email\",\"label\":\"Email\",\"fieldType\":\"email\",\"required\":true,\"hidden\":false,\"validation\":{\"useDefaultBlockList\":true},\"dependentFields\":[],\"placeholder\":\"you@example.com\",\"description\":\"We'll never share your email\"},{\"objectTypeId\":\"0-1\",\"name\":\"company_type\",\"label\":\"Company Type\",\"fieldType\":\"dropdown\",\"required\":true,\"hidden\":false,\"validation\":{},\"dependentFields\":[{\"fieldName\":\"enterprise_fields\",\"objectTypeId\":\"0-1\",\"controllingValue\":\"enterprise\",\"condition\":\"EQUAL\",\"active\":true}],\"options\":[{\"label\":\"Small Business\",\"value\":\"small\"},{\"label\":\"Enterprise\",\"value\":\"enterprise\"}]}]}" | ||
| ]\` | ||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Example is hard to follow (double-escaped JSON). Provide a practical copy/paste.
Show both the object and how it should be entered as one array item string.
- **COMPLETE EXAMPLE:**
- `[
- "{\"groupType\":\"default_group\",\"richTextType\":\"text\",\"richText\":\"<h3>Contact Info</h3>\",\"fields\":[{...}]}"
- ]`
+ **Example (one array item):**
+ Object:
+ {
+ "groupType": "default_group",
+ "fields": [
+ {
+ "objectTypeId": "0-1",
+ "name": "email",
+ "label": "Email",
+ "fieldType": "email",
+ "required": true
+ }
+ ]
+ }
+ Enter as string in Field Groups item:
+ "{\"groupType\":\"default_group\",\"fields\":[{\"objectTypeId\":\"0-1\",\"name\":\"email\",\"label\":\"Email\",\"fieldType\":\"email\",\"required\":true}]}"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **COMPLETE EXAMPLE:** | |
| \`[ | |
| "{\"groupType\":\"default_group\",\"richTextType\":\"text\",\"richText\":\"<h3>Contact Info</h3>\",\"fields\":[{\"objectTypeId\":\"0-1\",\"name\":\"email\",\"label\":\"Email\",\"fieldType\":\"email\",\"required\":true,\"hidden\":false,\"validation\":{\"useDefaultBlockList\":true},\"dependentFields\":[],\"placeholder\":\"you@example.com\",\"description\":\"We'll never share your email\"},{\"objectTypeId\":\"0-1\",\"name\":\"company_type\",\"label\":\"Company Type\",\"fieldType\":\"dropdown\",\"required\":true,\"hidden\":false,\"validation\":{},\"dependentFields\":[{\"fieldName\":\"enterprise_fields\",\"objectTypeId\":\"0-1\",\"controllingValue\":\"enterprise\",\"condition\":\"EQUAL\",\"active\":true}],\"options\":[{\"label\":\"Small Business\",\"value\":\"small\"},{\"label\":\"Enterprise\",\"value\":\"enterprise\"}]}]}" | |
| ]\` | |
| **Example (one array item):** | |
| Object: | |
| { | |
| "groupType": "default_group", | |
| "fields": [ | |
| { | |
| "objectTypeId": "0-1", | |
| "name": "email", | |
| "label": "Email", | |
| "fieldType": "email", | |
| "required": true | |
| } | |
| ] | |
| } | |
| Enter as string in Field Groups item: | |
| "{\"groupType\":\"default_group\",\"fields\":[{\"objectTypeId\":\"0-1\",\"name\":\"email\",\"label\":\"Email\",\"fieldType\":\"email\",\"required\":true}]}" |
🤖 Prompt for AI Agents
components/hubspot/actions/create-form/create-form.mjs lines 110-114: the
example shows double-escaped JSON which is hard to copy/paste; replace it with a
clear practical example that first shows the JavaScript object form and then the
exact string value to paste (an array with one JSON-stringified item), e.g.,
present the object in normal JSON formatting and immediately below show the
corresponding single-item array string (the object stringified once, not
double-escaped) so users can copy either the object or the ready-to-paste
string.
Added a thorough and complete description of the fieldGroups parameter
WHY
The current description is great but the field is complex and it is important for users to fully understand how it can be populated (as it is a nest object in reality but sent as a list of string to the API)
Summary by CodeRabbit