NodeFox logoNodeFox

REST API

Overview

NodeFox workflows can be exposed and triggered through HTTP interfaces, allowing integration with external systems, internal services, and frontend applications.

Common patterns

Trigger workflow execution

  • Accept request payload
  • Route payload into workflow entry node
  • Return synchronous response or execution reference

Read execution status

  • Query by run identifier
  • Retrieve outcome, status, and timing metadata

Retrieve run diagnostics

  • Access node-level traces for debugging and observability

Endpoint design guidance

Use stable, versioned endpoints:

  • POST /v1/workflows/{workflowId}/runs
  • GET /v1/runs/{runId}
  • GET /v1/runs/{runId}/trace

Request payload practices

  • Validate optional fields before triggering execution
  • Prefer explicit schema contracts for payload shape
  • Include correlation identifiers for cross-system tracing

Response patterns

For fast workflows, synchronous responses may be sufficient.

For longer workflows, return run metadata immediately and poll status endpoints.

Security considerations

  • Authenticate all workflow-trigger endpoints
  • Scope permissions by workspace and workflow
  • Rate limit external callers
  • Log invocation metadata for auditability