Markdown
How FlowRelay works
Plain Markdown for agents, CLIs, MCP clients, and readers who want a copyable text version.
# How FlowRelay works
Canonical: https://docs.flowrelay.app/getting-started/
Markdown: https://docs.flowrelay.app/getting-started.md
FlowRelay receives events from outside Shopify, checks them, and hands the matching trigger to Shopify Flow.
## What FlowRelay does
FlowRelay is the event front door for Shopify Flow. It gives each outside sender a controlled endpoint, records a receipt, and keeps recovery work tied to safe evidence.
## What Delivered means
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.
## Where to go next
Most teams start with one test event, then add authentication, connect the Flow trigger, and use receipts to verify what happened.
- [Install FlowRelay from the Shopify App Store](https://apps.shopify.com/flowrelay-1): Use the listing when you are ready to add FlowRelay to a Shopify store.
## Start path
Use this order when you are new to FlowRelay.
- Start with a concrete use case, such as a supplier update, ERP event, warehouse status, partner alert, or custom app event that should start Shopify Flow.
- Create an endpoint for that sender, set its Source label and default event type, and choose the trigger variant Shopify Flow should receive.
- Choose an authentication mode with the sender owner and keep all generated secret material private.
- Add the matching FlowRelay trigger to a safe Shopify Flow workflow.
- Send a test event with synthetic data, open the FlowRelay receipt, and confirm the handoff boundary.
## Handoff Boundary
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.
## Related
- [Send your first test event](https://docs.flowrelay.app/getting-started/first-event.md)
- [Create an endpoint](https://docs.flowrelay.app/setup/endpoints.md)
- [Read receipts](https://docs.flowrelay.app/operate/receipts.md)
## Safety Boundary
Do not share endpoint secrets, authentication headers, HMAC values, tokens, raw event bodies, customer records, Shopify sessions, store passwords, or database URLs in public examples.
FlowRelay