Webhooks
Inbound webhooks
Inbound webhooks are commonly used to start workflows from external systems.
In a headless deployment (Pro and Enterprise), the nf runner provides the inbound endpoint: nf dispatch <artifact> --webhook arms a bearer-token-protected route on the runner, listening on loopback by default. To receive calls from outside the machine, put your own reverse proxy with TLS in front of it. See Headless execution.
Recommended flow
- Receive webhook payload
- Validate signature or token
- Normalize payload in a Reader/Code step
- Route through Decision logic for workflow branching
Outbound webhooks
Outbound webhook calls are commonly handled through Writer API variants.
Use outbound webhooks for:
- Completion events
- Failure notifications
- System-to-system state synchronization
Reliability guidance
- Use retry/fallback branches for transient destination failures
- Preserve idempotency keys where possible
- Record response status and payload snippets for diagnostics
Security guidance
- Verify signatures on inbound hooks
- Avoid hardcoding secrets in workflow text fields
- Restrict outbound destinations to trusted systems