Skip to main content

Incoming Webhook

Start workflows from a simple GET API call.

Pre-requisite​

A Workflow with an Incoming Webhook function node.

Configuration​

See platform reference: How to configure Webhook

Copy hook url directly from your workflow editor page

Usage​

Call given url from your own http client.

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/h/xxx/yyy  -H 'Authorization: {ACCESS_KEY}' \
                                            -H 'X-ZPARSE-IO-ATTR: {CUSTOM_ATTR}' \
                                            -H 'X-ZPARSE-IO-AUTH: {CUSTOM_AUTH}'

Response​

tracker_uuid (string)

Tracker identifier to follow up on workflow execution. See tracker API


Sample response:
{ "tracker_uuid": "xxx-yyy-zzz" }
note

Hook are executed asynchronously meaning even for long duration processing, response will be instant.