Skip to main content

HTTP Server: Form endpoint

Listen to HTTP request on provided URL, expect a multipart form matching the configured fields and start the workflow.

Parameters​

URL

Copy this URL to send your form in this workflow from your own client.

Example:
https://api.zparse.io/workflow/e/form/xxx/yyy
Public

Make your workflow public, if checked no security header check is performed. Anyone with the URL can trigger the workflow — only enable for short-lived public flows.

Form fields

Describe what the form accepts. Each field defines one part of the multipart submission and one output connector:
- Key: name of the form part to read (also the connector key).
- Label: human-readable connector label (falls back to the key).
- Type: Plain text, Integer, JSON or File.
- Mandatory: if checked, a submission without this field is rejected.
- Default value (all types except File): used when an optional field is not submitted.

Submitted parts that do not match a configured key are ignored. Integer values must parse as whole numbers and JSON values must be valid JSON, otherwise the request fails.

Output​

One connector per form field

Each configured field produces an output connector named after its key (labeled by its label), typed according to the field type (PlainText, Integer, JSON or File). Mandatory fields produce required connectors; optional fields produce optional connectors that emit their default value when the field is not submitted.

Header: Auth
Forwarded header X-ZPARSE-IO-AUTH
Header: Attribute
Forwarded header X-ZPARSE-IO-ATTR
Responder

Link this to a responder to build the payload returned to the client.
- File response
- JSON response


This endpoint answers asynchronously with the execution tracker, so the responder payload is retrieved from the tracker rather than inline — see Form endpoint.

Usage​

Send the form as a multipart/form-data POST request, one part per configured field:

Example using curl:
curl https://api.zparse.io/workflow/e/form/xxx/yyy \
  -XPOST \
  -F "name=hello" \
  -F "document=@/path/to/file.pdf" \
  -H 'Authorization: {ACCESS_TOKEN}' \
  -H 'X-ZPARSE-IO-ATTR: {CUSTOM_ATTR}' \
  -H 'X-ZPARSE-IO-AUTH: {CUSTOM_AUTH}'