API Input Node

Basic

When this node runs, it listens on an URL for user-submitted data.

In WebSocket subscription, you will see an event with type "event": "ApiInput":

{
  stream_id: 3,
  event: "ApiInput",
  data: {
    time: "2025-05-01T04:04:52.530223810Z",
    url: "http://localhost:8080/flow/submit/266ce6474131874412a2b9acd46497e58c2b04fcecd7a9738bad777ec9ebcd7f",
    flow_run_id: "fe853183-28b2-4f83-bd22-6cad8a2e2847"
  }
}

This event contains a URL to submit the data.

• Send POST request to submit

  const body = { value: { S: "Hello" } };
  await fetch(event.data.url, {
      method: "POST",
      headers: [["content-type", "application/json"]],
      body: JSON.stringify(body),
  })

  In above example, node will output a string "Hello".

• Send DELETE request to cancel

  await fetch(event.data.url, {
      method: "DELETE",
  })

  Node will return an error: "canceled by user".

You can set timeout via input, default is no timeout.

Receive event with web hook

Pass the web hook URL to webhook_url input, the URL will receive a POST request with JSON body such as:

{
  "url": "http://dev-api.spaceoperator.com/flow/submit/4bbf11cdebd0a277a712764158ddca9b4cfb8303726a3e391f3454001df65a83",
  "flow_run_id": "53fc4a91-e74f-48c6-838c-c7249c0fb3e1",
  "node_id": "572cccb3-f702-4f1a-a7b1-3612cfd6d7f5",
  "times": 0,
  "timeout": 5,
  "extra": {
    "key": "value"
  }
}

You can use webhook_headers input to set headers such as for authentication.