Start a flow
When an API operation is called
Starts the flow when its operation of a published API is called, with the call as its record.
Nodes › TriggersOpen in Neblex
- Good for
- Your own API, backed by a flow
- Role
- Starts a flow
- Find it in
- Nodes › Triggers
When to use it
- Partners or your own software should call a versioned API with their own keys, plans and quotas.
- The answer should come from a flow: look something up, check it and answer.
- You want to answer early with Respond and keep working after the caller has its answer.
Reach for something else when
WebhookWhen a system sends events and needs no keys, plans or API documentation.When calledWhen only your own flows and agents call it.
Example
A partner calls POST /orders on your published API; the flow checks the order, answers 202 with the order number and then creates it in the ERP.
How it works
- Settings
- API and Operation; in the API, point that operation at this flow.
- Output
- One record, the call:
params,query,headers(only those the operation allows),bodyandcaller. - Behaviour
- A Respond step answers the caller as soon as it has the answer, and the run carries on; without one the caller gets the run's last records.
Add it to a flow
- Open the flow from Build › Workflows.
- Open Nodes and find When an API operation is called under Triggers. Drag it onto the canvas as the first step.
- Connect it to the next step and open its settings with ✎ Edit.
- Save and test with Run, then set the flow Active so it starts on its own.
More in Start a flow
WebhookStarts the flow the moment another system calls its address.Nodes › TriggersForm (starts flow)Starts the flow when someone submits a form, with their answers as the input.Nodes › TriggersScheduleRuns the flow on a repeating interval or at set times.Nodes › TriggersPoll for changesChecks a system regularly and starts a run only for records that are new or changed.Nodes › TriggersLive streamSubscribes to a queue, topic or stream and runs the flow for each message as it arrives.Nodes › TriggersWhen calledMakes the flow callable by other flows, the API and AI agents, with a declared input and output.Nodes › Triggers