Shapes

Start a flow

Webhook

Starts the flow the moment another system calls its address.

Nodes › TriggersOpen in Neblex
Good for
Real-time events from other systems
Role
Starts a flow
Find it in
Nodes › Triggers

When to use it

  • A system can send a request when something happens, such as a new order or a payment.
  • You want to offer a flow as an API endpoint that answers with the flow's result.
  • GitHub, Stripe or Shopify should register the webhook for you when the flow is activated.

Reach for something else when

Poll for changesWhen the system cannot call out, but you can read from it.Form (starts flow)When the input comes from a person rather than a system.

Example

Your shop calls the webhook for each new order. The flow keeps orders above a set amount and creates the customer in your CRM.

  1. Webhook
  2. Filter
  3. HubSpot

How it works

Settings live on the trigger node:

  • Enable webhook trigger and the Webhook URL (copy button). The address has the form https://if.neblex.com/api/hooks/<workspace>/<flow id or custom path>.
  • Custom path (optional): a readable path such as orders-inbound (letters, digits, -, _; up to 64). Available only when Authentication is not None; an unauthenticated webhook keeps its unguessable address.
  • HTTP methods: GET, POST, PUT, PATCH, DELETE (default POST).
  • Authentication: None (public URL), Basic (username and password), Header secret, JWT (HS256), HMAC signature, Body signature (for providers such as GitHub: X-Hub-Signature-256, HMAC-SHA256 or SHA1), API consumer key, AS2 trading partner, AS4 trading partner. Secrets are held in a Secret connection; the Header name is configurable.
  • Respond: When the flow finishes (return its data) or Immediately (run in the background).
  • API lifecycle: Active, Deprecated (adds a Deprecation header and a Sunset date), Retired (answers 410 Gone).
  • Reverse proxy to backend (optional): forward the request to your own backend instead of running the flow, with timeout, body and response size limits, caching, header rules and a request body schema.
  • Auto Register With: GitHub, Stripe or Shopify. Choose the provider API connection and events; when the flow is activated the webhook is registered with the provider for you, and removed when it is turned off.
  • Who can call this flow: workspace default, anyone, or only listed IP ranges. See Inbound Access.
# Call a webhook protected with a header secret
curl -X POST "https://if.neblex.com/api/hooks/acme/orders-inbound" \
  -H "content-type: application/json" \
  -H "X-Api-Key: <secret from the connection>" \
  -d '{"id":"A-1001","customer":"Acme","amount":250}'

In the flow, read the body with paths such as body.id and headers with headers.x-request-id.

More in the guide

Add it to a flow

  1. Open the flow from Build › Workflows.
  2. Open Nodes and find Webhook 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.

More in Start a flow

Form (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 › Triggers