FlowRelay
Setup
Event types and payloads
FlowRelay for Shopify Flow supports a fixed set of trigger variants. Choose the one your workflow needs, then make sure the sender can provide the required JSON fields.
Steps
Complete these in order.
-
Start with Generic when possible
Start with Generic when you only need a custom event to start a Shopify Flow workflow.
-
Choose native reference variants deliberately
Choose Order, Customer, or Product when the workflow needs Shopify's native resource reference for that object.
-
Choose related-resource variants deliberately
Choose Inventory, Fulfillment, Return/refund, or Company/B2B when the workflow needs the related Shopify resource that trigger variant references.
-
Map sender-supplied identifiers
For native or related-resource variants, configure the payload field path where FlowRelay can find the required Shopify ID or GID.
-
Require only necessary fields
Add up to five required payload paths only for fields the sender must always include.
-
Verify the resolved mapping
Send a test event with synthetic data and confirm the receipt shows the expected mapping result before enabling production traffic.
Supported variants #
The Shopify Flow edition supports a fixed set of trigger variants. Choose the variant that matches what the workflow needs from the event.
| Variant | Use when | Payload requirement |
|---|---|---|
| Generic | The workflow only needs a custom external event. | Valid JSON and any required paths you configure. |
| Order, Customer, or Product | The workflow needs a native Shopify resource reference. | A configured payload field path to the relevant Shopify ID or GID. |
| Inventory, Fulfillment, Return/refund, or Company/B2B | The workflow needs inventory, fulfillment, return/refund, or company/B2B context. | A configured payload field path for the related-resource identifier FlowRelay supplies to Shopify Flow as text context. FlowRelay does not fetch or resolve the related object. |
When to use the reference #
Use the trigger variants and event mapping reference when an operator or authorized agent needs field-level guidance, API values, resource path rules, or synthetic JSON examples before creating or editing an endpoint.
- Trigger variants and event mappingField-by-field reference for humans and agents.
Required paths #
Use required paths only for fields the sender must always provide. Missing required values fail early with a FlowRelay support code instead of becoming a vague downstream workflow issue.
Success check #
The test receipt shows the selected trigger variant, resolved event type, mapped identifier when required, validation result, and whether the matching Shopify Flow trigger was ready. When more than one endpoint or workflow uses the same trigger variant, add Shopify Flow conditions for the endpoint Source label and the resolved Event type so only the intended workflow path runs.
Delivered means FlowRelay handed the trigger to Shopify Flow. It does not mean downstream Shopify Flow branches, app calls, fulfillment changes, emails, or later systems completed.