Webhook
The Webhook Processor exposes an HTTP endpoint directly within an analytics flow, letting external systems trigger the flow with an HTTP request.
Why use the Webhook Processor
Use this processor when an external system, such as SCADA, an ERP, a cloud scheduler, or any REST client, needs to trigger an analytics flow directly over HTTP, without building a separate integration through DataHub or Flows.
How it works
Each Webhook processor is reachable at /analytics/v2/hook/{path} or by its processor ID alone if no path is configured. The processor accepts a request, injects it into the flow, and returns a response based on its configured response mode:
- immediate: Waits for the synchronous downstream chain to finish. Returns a 200 response or 500 if a processor in the chain fails. To return a specific status code, header, or body instead of an empty 200, place a Webhook Response Processor at the end of the chain.
- async: Waits instead for a reply value to loop back into this processor, and returns that value as the response body. Returns 408 if no reply arrives before the timeout.
Parameters
Parameter | Details |
|---|---|
Response Mode | How the hook endpoint responds: immediate or async. Default: immediate. |
Timeout | Number of seconds to wait in async mode before returning a timeout. |
Path | An optional custom subpath the hook is reachable at in addition to its processor ID: /analytics/v2/hook/{path}. Can span several segments separated by forward slashes / (for example, part1/part2/part3). Enter the path in decoded form: ?, #, %. Escapes and control characters are rejected. Characters that need escaping must be percent-encoded. Leave empty to route by processor ID only. |
Allow Methods | The HTTP methods the hook accepts as a comma-separated list (GET, POST, PUT, PATCH, DELETE). Leave empty to accept any method. A request using a disallowed method is rejected with 405. |