Gravity Forms

Overview

The node interacts with the Gravity Forms REST API v2, specifically providing functionality to retrieve a summary of a form's structure and metadata. The "Form Summary" operation under the "Tool" resource fetches details about a specified form, including its ID, title, description, and an array of its fields with key attributes such as field ID, label, type, and whether the field is required.

This node is beneficial when you want to quickly obtain an overview of a form’s configuration without retrieving full form data or entries. For example, it can be used to dynamically generate UI elements based on form fields, validate form structures before processing submissions, or integrate form metadata into other workflows.

Properties

Output

The output JSON contains a summary object with the following structure:

• id: The unique identifier of the form.
• title: The title of the form.
• description: A textual description of the form.
• fields: An array of objects representing each field in the form. Each field object includes:
  • id: The unique identifier of the field.
  • label: The display label of the field.
  • type: The type of the field (e.g., text, checkbox).
  • required: A boolean indicating if the field is mandatory.

Example output JSON snippet:

{
  "id": 123,
  "title": "Contact Us",
  "description": "Form to collect contact information",
  "fields": [
    {
      "id": 1,
      "label": "Name",
      "type": "text",
      "required": true
    },
    {
      "id": 2,
      "label": "Email",
      "type": "email",
      "required": true
    }
  ]
}

No binary data is produced by this operation.

Dependencies

• Requires an active connection to the Gravity Forms REST API v2.
• Requires an API authentication token configured in n8n credentials to authorize requests.
• The node depends on the helper function that performs authenticated HTTP requests to the Gravity Forms API.

Troubleshooting

• Empty or invalid Form ID: If the Form ID property is empty or invalid, the node will throw an error indicating that the Form ID must not be empty.
• Invalid JSON input: Although not directly applicable to this operation, the node validates JSON inputs for other operations; malformed JSON will cause errors.
• API connectivity issues: Errors may occur if the API endpoint is unreachable or credentials are incorrect. Verify API keys and network access.
• Unsupported operation or resource: If the node is misconfigured with unsupported operations or resources, it will throw descriptive errors.
• To handle errors gracefully, enable the "Continue On Fail" option to allow the workflow to proceed even if this node encounters an error.

Links and References

• Gravity Forms REST API v2 Documentation