Skip to main content

JSON Endpoint

Send JSON body to workflows from a POST API call.

Pre-requisite​

A Workflow with a JSON endpoint function node.

Configuration​

See platform reference: How to configure JSON endpoint

Copy endpoint url directly from your workflow editor page

Usage​

Call given url from your own http client via POST request.

body (valid json)—REQUIRED
Any valid JSON.
Authorization (header)

If private workflow: Configured access key. Cf: How to handle Authentication.

Content-type (header)—REQUIRED
Must be application/json
X-ZPARSE-IO-ATTR (header)

Optional header you can use to provide additional context to your call.

X-ZPARSE-IO-AUTH (header)

Optional header you can use to check extra security.


Example using Curl:
curl https://api.zparse.io/workflow/e/j/xxx/yyy \
  -H 'Authorization: {ACCESS_KEY}' \
  -H 'X-ZPARSE-IO-ATTR: {CUSTOM_ATTR}' \
  -H 'X-ZPARSE-IO-AUTH: {CUSTOM_AUTH}' \
  -XPOST -d '{"hello": "world"}'

Response​

Response is dependent on which responder your have wired on your function.