Skip to main content

HTTP Server: JSON endpoint

Listen to HTTP request on provided URL, expect a valid JSON and start the workflow.

Parameters

URL

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

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

Make your workflow public, if checked no security header check is performed.

Key extractions

Optionally extract specific values from the received JSON instead of forwarding it whole. Each extraction defines:
- Key: name (and label) of the resulting output connector.
- JSON path: path evaluated against the request body (e.g. $.user.id).
- Value type: String, Integer or JSON.
- Optional: whether the value may be absent from the request.

Output

JSON

JSON you sent in your request body. Only present when no key extraction is configured: with extractions, this connector is replaced by one output connector per extraction, keyed and labeled by the extraction key, typed according to its value type, and optional according to its flag. A non-optional extraction whose JSON path matches nothing fails the request.

Tracker

ID of the tracker to follow up on your workflow execution. See tracker API

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

Link this to a responder to return data to the client.
- File response
- JSON response

Usage

See API reference: JSON endpoint