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.

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: Used by APIEase in cases 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.