FlowRelay FlowRelay Docs Shopify Flow Search /
All docs pages

START

USE CASES

SET UP

OPERATE

RECOVER

AGENT ACCESS

REFERENCE

Markdown

FlowRelay and Shopify Sidekick

Plain Markdown for agents, CLIs, MCP clients, and readers who want a copyable text version.

# FlowRelay and Shopify Sidekick

Canonical: https://docs.flowrelay.app/agent-access/shopify-sidekick/
Markdown: https://docs.flowrelay.app/agent-access/shopify-sidekick.md

FlowRelay gives Shopify Sidekick a small, read-only view of setup and delivery status. Sidekick can check what is happening, explain the result, and open the relevant FlowRelay page. It cannot change anything for you.

## Choose what you need
- [Use read-only Sidekick](#use-read-only-sidekick): Ask a focused question and understand the safety boundary.
- [See what Sidekick can check](#see-what-sidekick-can-check): Review the setup, endpoint, receipt, and reliability questions Sidekick can answer.
- [Choose the right surface](#choose-the-right-surface): Use FlowRelay for changes and Agent Access for approved external agents.

## Use read-only Sidekick
Ask a focused question and understand the safety boundary.

### Agent workflow
Agents should orient through docs before using authenticated tools.
1. Ask Sidekick to check
   Ask about FlowRelay readiness, an endpoint, recent delivery receipts, a receipt result, or delivery reliability.
2. Review the explanation
   Sidekick returns a short, safe summary and can open the relevant page in FlowRelay.
3. Make changes in FlowRelay
   Use the FlowRelay app for configuration, tests, replay, secret rotation, billing, Agent Access, and support.

### Read-only by design
- Sidekick cannot create or change endpoints, send tests, replay events, rotate secrets, manage billing or Agent Access, or contact support for you.
- Sidekick does not receive endpoint URLs, secrets, raw payloads, authentication headers, external event IDs, tokens, customer records, or copied private logs.
- Sidekick is not the same as FlowRelay Agent Access and does not have API, CLI, or MCP-level authority.

## See what Sidekick can check
Review the setup, endpoint, receipt, and reliability questions Sidekick can answer.

### What Sidekick can check
Sidekick can answer a focused set of questions from inside Shopify Admin. It reads current FlowRelay information without changing billing, access, quotas, endpoints, receipts, or any other merchant-facing state.


- Question: Is FlowRelay ready?; What Sidekick can return: Setup readiness, checklist progress, and safe next steps.
- Question: Where is my endpoint?; What Sidekick can return: Matching endpoint names, status, readiness, and a link to FlowRelay.
- Question: What happened to my event?; What Sidekick can return: Recent receipt outcomes, safe failure context, and replay eligibility without replaying.
- Question: Is delivery healthy?; What Sidekick can return: A reliability summary for the store, an endpoint, or a trigger type.

## Choose the right surface
Use FlowRelay for changes and Agent Access for approved external agents.

### What stays in FlowRelay
Open the FlowRelay app to create or edit endpoints, connect Shopify Flow, send synthetic tests, replay eligible receipts, rotate secrets, manage billing or Agent Access, and contact support. Sidekick may link you to the right page, but it does not prepare or perform those actions.


### Choose the right access surface
Sidekick is useful for quick questions inside Shopify Admin. It is not a substitute for the FlowRelay app or for a separately approved external agent.


- Need: Check or understand FlowRelay; Use: Shopify Sidekick; Why: It provides a small read-only view and opens the relevant FlowRelay page.
- Need: Configure, test, or recover; Use: FlowRelay app in Shopify Admin; Why: This is the complete merchant surface and where changes are made.
- Need: Use an approved external agent; Use: FlowRelay Agent Access API, CLI, or MCP; Why: Scoped grants provide explicit authority, auditability, and the broader supported automation contract.

## 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
- [Agent Access](https://docs.flowrelay.app/agent-access.md)
- [New setup with an agent](https://docs.flowrelay.app/agent-access/setup-with-an-agent.md)
- [Read receipts](https://docs.flowrelay.app/operate/receipts.md)
- [Replay an event](https://docs.flowrelay.app/recover/replay.md)
- [Share diagnostics](https://docs.flowrelay.app/recover/diagnostics.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.

Local docs search