FlowRelay
Use Cases
Move one client event into Shopify Flow with proof and rollback
Use this page when an agency, developer, or implementation partner is coordinating one client event path. Choose the first endpoint guide for a new path, the swapover guide for a merchant-led replacement, or the Agent Access guides when an authorized agent will perform the work.
On this page
Start here #
Choose the right path for a new setup, a replacement, or a partner-led handoff.
When a partner should use this #
Use this page when a merchant wants a partner, Shopify developer, implementation team, or technical operator to set up or move one external event path into Shopify Flow. The goal is a small proofable path: the sender knows where to send, the merchant knows what FlowRelay received, the Shopify Flow owner knows what to check, and everyone knows who can roll back.
- First endpoint guideUse for a brand-new FlowRelay event path.
- Swap over to FlowRelayUse when replacing an existing receiver, webhook app, custom-code path, or manual process.
Use the right entrypoint #
Use a focused page for each job so the merchant does not receive a pile of generic docs.
| Job | Start here | Why |
|---|---|---|
| Trigger Shopify Flow from an outside system with receipt proof | External events into Shopify Flow | Explains the basic sender -> FlowRelay -> Shopify Flow boundary. |
| Move a custom webhook receiver to Shopify Flow without losing rollback | Swap over to FlowRelay | Keeps the pilot path, proof, rollback owner, and cutover window explicit. |
| Why did my Shopify Flow not run? | Recover a failed handoff | Starts from receipt facts, support codes, and the Delivered boundary. |
| Replay external events into Shopify Flow safely | Replay an event | Requires retention, preview, authority, and side-effect review. |
| Partner-safe Shopify Flow webhook diagnostics | Share diagnostics | Gives partners support-safe evidence without secrets or raw payloads. |
| Agent-ready Shopify Flow event setup checklist | Set up a new event path with an agent | Gives authorized agents a governed setup path and stop conditions. |
Run one handoff #
Keep the first client path small enough to prove and reverse.
Typical path
A typical path starts from the scenario, then moves into setup and verification.
-
Choose one event path
Choose one event path first: one sender, one FlowRelay endpoint, one Shopify Flow trigger, one proof event, and one rollback owner.
-
Use the matching setup guide
Use the first endpoint guide for a new event path or the swapover guide for an existing webhook receiver, middleware path, serverless function, or manual handoff.
-
Scope any agent access
If an authorized agent will help, give it the agent-safe setup or endpoint-swap guide and a scoped, time-bounded Agent Access grant.
-
Require Delivered proof
Collect proof from FlowRelay receipts, support codes, replay availability, diagnostics share readiness, and a separate Shopify Flow result check. 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.
-
Share redacted diagnostics
Share diagnostics instead of raw event bodies, authentication headers, endpoint secrets, Shopify tokens, customer data, or copied private logs.
-
Check capacity before cutover
Use the pricing page and plan-usage view before production cutover so event volume, diagnostics, replay, and Agent Access safeguards fit the merchant's rollout.
One event path checklist #
Keep the first path small enough to verify in one sitting. If the sender, authentication, mapping, or Shopify Flow workflow needs adjustment, the receipt and rollback owner should make the next step obvious.
| Field | Fill this before cutover | Use this doc |
|---|---|---|
| Sender and event purpose | System owner, event name, expected volume, criticality, and whether this is new setup or replacement. | First endpoint guide or Swap over to FlowRelay |
| Shopify Flow target | Trigger variant, required payload paths, safe test workflow, and downstream result check owner. | Trigger variants and mapping |
| Proof | A Delivered receipt for the FlowRelay handoff, support code if any, replay state, diagnostics share readiness, and a separate Shopify Flow result check when downstream outcome matters. Accepted alone is not cutover proof. | Read receipts |
| Rollback owner | Named person or team that can restore the old sender URL/auth path during the agreed window. | Swap over to FlowRelay |
| Support boundary | Diagnostics share path, support contact path, and the private data nobody should request or paste. | Share diagnostics and Work with support |
| Plan fit | Expected accepted events, replay/diagnostics needs, Agent Access usage, and whether monthly or annual approval fits production use. | Usage limits and Pricing |
Copy a narrow brief #
Give an authorized agent one event path, one grant, and explicit stop points.
Give an agent a narrow brief #
When the merchant authorizes an agent to help, keep the brief narrow: one event path, one scoped grant, and clear stop points before changes that could affect production or billing. Keep tokens and secrets in the agent client's private secret store or environment.
You are helping [merchant/store] set up or move one external event path into Shopify Flow through FlowRelay. Read https://docs.flowrelay.app/use-cases/agency-developer-partner-kit/ first.
Work only inside the merchant-authorized, store-scoped Agent Access grant. Confirm whoami, plan usage, endpoint state, trigger mapping, and the exact event path before changing anything.
Stop for operator approval before sender URL or auth changes, Shopify Flow workflow changes, billing approval, grant changes, replay, diagnostics sharing, support submission, or production traffic.
Do not ask for endpoint secrets, authentication headers, HMAC values, Shopify tokens, session data, raw event bodies, customer records, database URLs, store passwords, copied private logs, or screenshots containing private values. Use receipt IDs, support codes, diagnostics share IDs, redacted summaries, approximate timestamps, endpoint names, intended workflow descriptions, and refusal details.
Final summary: sender, endpoint, trigger variant, proof receipt, Shopify Flow result check owner, rollback owner, plan fit, unresolved approvals, and next safe action.Work within the boundaries #
Share safe evidence, keep private data out of the handoff, and confirm plan fit.
What not to ask merchants for #
Do not ask for endpoint secrets, authentication headers, HMAC values, Shopify tokens, session data, raw event bodies, customer records, database URLs, store passwords, copied private logs, or screenshots containing private values. Do not ask for browser storage or cookies. If those seem necessary, stop and use diagnostics, a receipt ID, a support code, a redacted summary, or a merchant-run sender resend instead.
Check plan fit before production #
Before production traffic moves, check expected event volume, diagnostics needs, replay use, and Agent Access usage against the merchant's plan. An annual plan can lower cost for steady volume. The partner or agent can prepare and present the recommendation, but billing approval stays with the merchant in Shopify's hosted billing - FlowRelay, agents, and partners never approve a charge.
- PricingMonthly and annual plan options for FlowRelay for Shopify Flow.
- Usage limitsAccepted events, diagnostics shares, replay executions, Agent Access safeguards, and paid-plan grace.
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.