FlowRelay Docs for Shopify Flow

# FlowRelay Docs for Shopify Flow

Canonical: https://docs.flowrelay.app/
Markdown: https://docs.flowrelay.app/index.md

FlowRelay docs for Shopify Flow setup, receipts, recovery, Agent Access, and machine-readable references.

## Choose your path

### External events into Shopify Flow
Let a supplier, app, or back-office system start a Shopify Flow workflow through FlowRelay.

- Overview: https://docs.flowrelay.app/use-cases/external-events-to-shopify-flow/
- Quickstart: https://docs.flowrelay.app/getting-started/first-endpoint/

### Recover a failed handoff
Use receipts, support codes, and replay controls when an event needs attention.

- Overview: https://docs.flowrelay.app/use-cases/recover-failed-handoff/
- Support codes: https://docs.flowrelay.app/recover/error-codes/

### Agent Access
Use scoped, revocable grants so an authorized agent can help set up, monitor, and diagnose FlowRelay without broad store authority.

- Overview: https://docs.flowrelay.app/agent-access/
- Set up with an agent: https://docs.flowrelay.app/agent-access/setup-with-an-agent/

### Agency & developer partner kit
Move one client event path into Shopify Flow with proof, rollback ownership, agent-safe setup, and support-safe diagnostics.

- Partner guide: https://docs.flowrelay.app/use-cases/agency-developer-partner-kit/
- Swapover guide: https://docs.flowrelay.app/use-cases/swapover-to-flowrelay/

## Docs Paths

### Setup
- [First endpoint guide](https://docs.flowrelay.app/getting-started/first-endpoint/): Create one endpoint, connect the matching Shopify Flow trigger, send one safe test event, and confirm the receipt before production traffic.
- [Create an endpoint](https://docs.flowrelay.app/setup/endpoints/): Create the sender-facing URL and choose the event type Shopify Flow should receive.
- [Authenticate requests](https://docs.flowrelay.app/setup/authentication/): Choose HMAC-SHA256 or static-header authentication without exposing secrets.
- [Event types and payloads](https://docs.flowrelay.app/setup/event-types-and-payloads/): Choose the Shopify Flow trigger variant and required payload field paths your sender can support.
- [Permissions and data access](https://docs.flowrelay.app/setup/permissions-and-data-access/): Understand when native Shopify Flow references require optional read scopes and what FlowRelay does not query or sync.
- [Trigger variants and event mapping](https://docs.flowrelay.app/setup/trigger-variants-and-event-mapping/): Use the field-by-field reference when choosing trigger variants or configuring mapping paths.
- [Add the Shopify Flow trigger](https://docs.flowrelay.app/setup/shopify-flow-trigger/): Enable the FlowRelay trigger that receives the event in Shopify Flow.
- [Send your first test event](https://docs.flowrelay.app/getting-started/first-event/): After the endpoint and matching Flow trigger are ready, send a safe test event and confirm one Delivered receipt.

### Operate
- [Read receipts](https://docs.flowrelay.app/operate/receipts/): See what FlowRelay accepted and where the handoff stopped.
- [Event history](https://docs.flowrelay.app/operate/event-history/): Find accepted, delivered, failed, replayed, and retained events without copying private data.
- [Event lifecycle](https://docs.flowrelay.app/operate/event-lifecycle/): Understand accepted, queued, delivered, failed, no-workflow, duplicate, and replay states.
- [Retention](https://docs.flowrelay.app/operate/retention/): Know what FlowRelay keeps, when replay expires, and what remains as safe receipt evidence.
- [Usage limits](https://docs.flowrelay.app/operate/usage-limits/): Compare plan capacity, what counts against usage, paid-plan grace, and operational safeguards.
- [Rotate credentials](https://docs.flowrelay.app/setup/rotate-credentials/): Replace an exposed or stale endpoint secret without revealing the old value.

### Recover
- [Support codes](https://docs.flowrelay.app/recover/error-codes/): Look up a support code and what to do next.
- [Retries, replay, and resend](https://docs.flowrelay.app/recover/retries-replay-and-resend/): Separate sender retries, FlowRelay processing reconciliation, and deliberate replay.
- [Replay an event](https://docs.flowrelay.app/recover/replay/): Preview side effects before a recovery replay.
- [Duplicates and idempotency](https://docs.flowrelay.app/recover/duplicates-and-idempotency/): Understand duplicate suppression and action idempotency before resending or replaying.
- [Share diagnostics](https://docs.flowrelay.app/recover/diagnostics/): Send redacted evidence to support or a partner.
- [Work with support](https://docs.flowrelay.app/recover/support-signals/): Use receipts, diagnostics, and redacted support summaries when FlowRelay support needs evidence.

### Swap over
- [Swap over to FlowRelay](https://docs.flowrelay.app/use-cases/swapover-to-flowrelay/): Replace a brittle webhook, custom-code, or manual event path with a safe pilot and rollback plan.
- [Plan a safe endpoint swap](https://docs.flowrelay.app/agent-access/endpoint-swap-plan/): Inventory current lanes, choose one safe pilot, check plan fit, and prepare rollback.

### Agent Access
- [Agent Access](https://docs.flowrelay.app/agent-access/): Authorize an agent through scoped, revocable grants without handing over broad store authority.
- [Grants and scopes](https://docs.flowrelay.app/agent-access/grants-and-scopes/): Compare authority tiers, expiration choices, revocation, audit, and hard boundaries.
- [Agent and API rate limits](https://docs.flowrelay.app/agent-access/rate-limits-and-backoff/): Use 429 fields, Retry-After, and grouped rate-limit families to keep automated work safe.
- [Availability and refusals](https://docs.flowrelay.app/agent-access/availability-and-refusals/): Understand how capabilities, scopes, object state, usage limits, and safety rules decide what an agent can do.
- [Agent orientation](https://docs.flowrelay.app/agent-access/agent-orientation/): Give authorized agents the right docs, Markdown pages, OpenAPI, CLI, skills, and MCP Agent Operations access.
- [Agent mission playbooks](https://docs.flowrelay.app/agent-access/agent-mission-playbooks/): Map common operator missions to the context an agent should gather and the actions it may prepare.
- [Set up with an agent](https://docs.flowrelay.app/agent-access/setup-with-an-agent/): Create one endpoint, prove one delivered test event, and stop before human-only steps.
- [Shopify Sidekick](https://docs.flowrelay.app/agent-access/shopify-sidekick/): Use Shopify Sidekick inside Admin for compact FlowRelay reads and merchant-confirmed FlowRelay action screens.
- [FlowRelay Operator Skill](https://docs.flowrelay.app/agent-access/skills/): Install the FlowRelay Operator Skill for setup, receipt investigation, recovery, and support workflows.
- [Support, expansion, and feature requests](https://docs.flowrelay.app/agent-access/support-and-expansion-requests/): Route support issues, future-edition demand, and FlowRelay feature requests without bypassing review safeguards.

### Reference
- [Glossary](https://docs.flowrelay.app/reference/glossary/): Plain-language meanings for receipts, Delivered, support codes, replay, grants, and usage terms.
- [Agent Operations API](https://docs.flowrelay.app/reference/api/): Use the canonical machine contract for scoped reads and action previews.
- [CLI](https://docs.flowrelay.app/reference/cli/): Run npx flowrelay-agent for docs discovery, doctor checks, JSON reads, and action previews.
- [MCP](https://docs.flowrelay.app/reference/mcp/): Use MCP Agent Operations access over the same scoped Agent Operations contract when it is enabled.
- [Action previews](https://docs.flowrelay.app/reference/action-intents/): Describe preview, confirmation, idempotency, and audit structure.
- [OpenAPI](https://docs.flowrelay.app/reference/openapi/): Expose schema and machine-readable contract locations.

## 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.