Operations

Available Formfex operations in the n8n node


Overview

The Formfex action node organizes operations by three resources: Form, Response, and AI. Each operation maps to a Public API endpoint.

Operations Reference

ResourceOperationAPI EndpointScope
FormCreatePOST /formsFORMS_WRITE
FormGetGET /forms/:idFORMS_READ
FormGet ManyGET /formsFORMS_READ
FormUpdatePATCH /forms/:idFORMS_WRITE
FormDeleteDELETE /forms/:idFORMS_WRITE
FormPublishPOST /forms/:id/publishFORMS_WRITE
FormUnpublishPOST /forms/:id/unpublishFORMS_WRITE
ResponseGetGET /forms/:id/responses/:responseIdRESPONSES_READ
ResponseGet ManyGET /forms/:id/responsesRESPONSES_READ
AIGenerate FormPOST /ai/generate-formAI_GENERATE
AIGet Job StatusGET /ai/jobs/:jobIdAI_GENERATE
AISmart AnalyticsPOST /forms/:id/smart-analyticsANALYTICS_READ
AIAnalytics ChatPOST /forms/:id/analytics-chatANALYTICS_READ

All endpoints are relative to /api/v1/public.


Form Operations

Create

Creates a new blank form with a title, optional description, and language.

Parameters:

ParameterTypeRequiredDescription
TitlestringYesForm title (max 200 characters)
DescriptionstringNoForm description (max 500 characters)
LanguageoptionsNoForm language: en, tr, es, it, de, nl. Default: en

Get

Retrieves a single form by its ID, including the full schema with fields and sections.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID

Get Many

Returns a paginated list of forms owned by the account.

Parameters:

ParameterTypeRequiredDescription
Return AllbooleanNoFetch all forms with auto-pagination (max 5,000)
LimitnumberNoMax forms to return (1–100). Shown when Return All is off
SearchstringNoFilter by title (case-insensitive partial match)
SincestringNoISO 8601 timestamp — only return forms updated after this date

Auto-Pagination

When Return All is enabled, the node automatically paginates through results. A safety cap of 50 pages (5,000 records) prevents accidental quota exhaustion. Use date filters (Since) to narrow large datasets.

Update

Updates form properties. Only provided fields are changed.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID
TitlestringNoNew form title
DescriptionstringNoNew description

Delete

Soft-deletes a form. The form is retained in the database but becomes inaccessible. Associated file uploads are permanently deleted.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID

Publish

Publishes a form so it starts accepting responses. Returns the share URL.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID

Unpublish

Unpublishes a form so it stops accepting new responses.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID

Response Operations

Get

Retrieves a single form response by ID.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID
Response IDstringYesThe response UUID

Get Many

Returns a paginated list of responses for a form.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID
Return AllbooleanNoFetch all responses with auto-pagination (max 5,000)
LimitnumberNoMax responses to return (1–100). Shown when Return All is off
SincestringNoISO 8601 timestamp — only return responses submitted after this date
Start DatestringNoFilter responses from this date
End DatestringNoFilter responses until this date

AI Operations

Plan Requirement

AI form generation requires a Starter plan. Smart Analytics and Analytics Chat require a Pro plan or higher. All AI operations consume credits.

Generate Form

Generates a complete form using AI from a natural language prompt. This is an async operation — the node dispatches a job, polls until it completes, and returns the created form.

Parameters:

ParameterTypeRequiredDescription
PromptstringYesDescribe the form to generate (max 400 characters)
LanguageoptionsNoLanguage for generated labels: en, tr, es, it, de, nl

Behavior:

  1. Dispatches the AI generation job
  2. Polls every 3 seconds for up to 60 seconds
  3. When the job completes, returns the full form with schema
  4. If the job fails, throws an error with the failure reason

Get Job Status

Returns the current status of an AI generation job. Useful for manual polling in custom workflows.

Parameters:

ParameterTypeRequiredDescription
Job IDstringYesThe job ID returned from Generate Form

Status values: PENDING, PROCESSING, DONE, FAILED

Smart Analytics

Dispatches an AI-powered analytics report for a form. Results are delivered asynchronously via a webhook callback URL.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID
Callback URLstringYesHTTPS URL where the report will be delivered

Behavior:

  • Returns immediately with a jobId and reportId
  • When the report is ready, Formfex sends a POST request to your callback URL with the full report (metrics, trends, AI analysis)
  • The callback payload is signed with X-FormFex-Signature-256 header

n8n Workflow Pattern

Pair this with an n8n Webhook node to receive the callback. Create a two-step flow: Formfex node dispatches the report, Webhook node receives the results.

Analytics Chat

Conversational Q&A about form response data. Supports multi-turn conversations via session IDs.

Parameters:

ParameterTypeRequiredDescription
Formresource locatorYesSelect from list or enter form ID
MessagestringYesYour question about the form data (max 500 characters)
Session IDstringNoContinue a previous conversation. Leave empty to start new

Response includes:

  • message — The AI-generated answer
  • sessionId — Pass this back for follow-up questions
  • suggestedActions — Suggested next questions
  • creditsUsed — Credits consumed

Multi-turn conversations

Pass the sessionId from the response into subsequent Analytics Chat operations to maintain conversation context. Sessions expire after 30 minutes of inactivity.


Example Workflows

Save responses to Google Sheets

Formfex Trigger → Google Sheets (append row)

AI-generate a form and share via Slack

Manual Trigger → Formfex (AI: Generate Form) → Formfex (Publish) → Slack (send form URL)

Daily analytics digest via email

Schedule Trigger (daily) → Formfex (Analytics Chat: "Summarize yesterday's responses") → Gmail (send digest)

Weekly Smart Analytics report

Schedule Trigger (weekly) → Formfex (Smart Analytics with callback)
...
Webhook Node (receives callback) → Slack / Email (distribute report)