Skip to main content

Publish File Endpoint

Our Publish File Endpoint feature provides a simple and secure way to get your data into Zparse. Just send a file from any application, and it will automatically trigger a workflow to process your data instantly. It’s the easiest way to connect your systems and put your data to work.

Pre-requisite​

To successfully send data to Zparse, your workflow must first be configured with a File endpoint function node. This node acts as the entry point for your data, generating a unique URL where you can securely publish files. Without this specific function node, the workflow cannot be triggered by external data, and you will not be able to send files to your pipeline.

Configuration​

See platform reference: How to configure File endpoint

Copy endpoint url directly from your workflow editor page

Usage​

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

file (form file)—REQUIRED
File you are will to send.
Authorization (header)

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

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/f/xxx/yyy \
  -H 'Authorization: {ACCESS_KEY}' \
  -H 'X-ZPARSE-IO-ATTR: {CUSTOM_ATTR}' \
  -H 'X-ZPARSE-IO-AUTH: {CUSTOM_AUTH}' \
  -XPOST -F "file=@/path/to/your/file.ext"
Example in python:
def publish_file(file_path, secret_key):
    headers = {
        'Authorization': secret_key,
    }

    with open(file_path, 'rb') as file:
        files = {'file': (file_path, file, 'application/octet-stream')}
        response = requests.post('https://api.zparse.io/workflow/e/f/xxx/yyy', files=files, headers=headers)
        return response

Response​

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