Getting Started
Send your first test event
Use this guide to prove the setup once with synthetic data before you send real business events.
Steps
Complete these in order.
-
Open Shopify Admin, open FlowRelay, and create a test endpoint for the sender or system you control.
-
Choose the event type Shopify Flow should receive. Use Generic for the first proof when no specific type is required.
-
Choose HMAC-SHA256 when the sender can sign requests; otherwise use static-header auth and store the generated value privately.
-
In Shopify Flow, create a safe workflow with the matching FlowRelay trigger and a harmless test action.
-
Send one test event with synthetic data from the sender, using non-customer values that are safe to store in a test receipt.
-
Open Event history in FlowRelay, open the receipt, and confirm Delivered only means FlowRelay handed the trigger to Shopify Flow.
Before you start #
Use a Shopify store where FlowRelay is installed, a sender you control, and a Shopify Flow workflow that is safe to run. Send synthetic values for the first event, not real customer or merchant data.
- Install FlowRelay from the Shopify App StoreInstall FlowRelay before following the first-event setup path.
Success check #
The receipt shows Accepted, then Delivered. Delivered means FlowRelay handed the trigger to Shopify Flow — after receiving, authenticating, validating, and normalizing the event. It does not show whether the Flow run finished or which branches matched; check that in Shopify Flow.
If it does not deliver #
Use the receipt outcome to pick the next owner instead of retrying blindly.
| Outcome | Likely owner | Next action |
|---|---|---|
| Authentication failed | Sender and endpoint setup | Fix the signing or static header setup, then ask the sender to send a fresh test event. |
| Required field or mapping failed | Sender payload or endpoint mapping | Fix the payload field path or sender event body. Use a sender resend because FlowRelay rejected the event before a successful handoff. |
| No matching Shopify Flow workflow | Shopify Flow setup | Enable the matching FlowRelay trigger, then preview replay if the accepted event is still retained. |
| Handoff failed | FlowRelay to Shopify Flow boundary | Read the support code, confirm replay availability, and share diagnostics if support or a partner needs evidence. |
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.
FlowRelay