Shapes

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

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.

  1. When an API operation is called
  2. Validate Records
  3. Respond
  4. NetSuite

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), body and caller.
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.
More in the guide

Add it to a flow

  1. Open the flow from Build › Workflows.
  2. Open Nodes and find When an API operation is called under Triggers. Drag it onto the canvas as the first step.
  3. Connect it to the next step and open its settings with ✎ Edit.
  4. Save and test with Run, then set the flow Active so it starts on its own.