Flow Requests

Flow requests hand data from APIEase to a Shopify Flow workflow. A Flow request is a request type, not an execution mechanism: add a suitable trigger when it is the entry request, or select its handle as Next Request when another APIEase request should continue into Flow.

To run a saved APIEase request from a Shopify Flow workflow, use APIEase Flow Action. For the APIEase-to-Flow setup, follow Minimal Flow integration.

Flow Request Fields

• Name: Optional display name.
• Handle: Stable identifier used when another request calls this one via a chained request.
• Type: Set to flow to trigger a Shopify Flow workflow.
• Parameters (?):
  • Flow: JSON key/value pairs passed to your workflow.
  • System: Control immediate responses and Flow response wait times, or configure behavior such as Customer Authentication.
  • Supply in app parameters or dynamic embedded parameters from the storefront.
  • Mark credentials or secrets as Sensitive so they are encrypted and never exposed in the storefront or admin UI.

Triggers (?): Choose how the request should be triggered:

• Automatically via webhook
• On a recurring schedule using cron
• As an endpoint served by APIEase via Proxy Endpoints
• Remote Calls from outside Shopify.
• Manually via the "Copy and Execute" link on the requests admin page
• From your storefront using Shopify's app proxy

See Triggers overview to choose an entry point and understand its prerequisite.

Next Request: You can specify the handle of another request to run after this request finishes. This allows you to build multi-step workflows using chained requests.

Return a result from the workflow

APIEase receives the result when your workflow runs APIEase Flow Action with the original executionId in its Flow Parameters JSON. Follow Minimal Flow integration to configure that callback.

Place the callback after the steps whose results the caller needs. Steps after the callback may still be running when the caller receives its response. Without a resolving callback, a waiting request can reach its wait limit.

Concurrent calls and queued responses

Two simultaneous calls to the same request ID can each wait for their own Flow result. The current default allows up to 10 concurrent executions per request ID, per shop.

When the concurrency limit is reached, an additional call is queued and immediately returns Request queued with an execution ID. That response confirms the call was queued, not that its workflow has completed. The queued work is processed in the background when capacity becomes available.

Neither disabling immediate response nor increasing the response wait time changes this queue behavior. See Flow Parameters to configure those settings.