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.

## Use Cases

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

- Guide: https://docs.flowrelay.app/use-cases/external-events-to-shopify-flow/
- Related setup: https://docs.flowrelay.app/setup/endpoints/

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

- Guide: https://docs.flowrelay.app/use-cases/recover-failed-handoff/
- Related setup: https://docs.flowrelay.app/recover/error-codes/

### Work with a partner without sharing secrets
Share redacted evidence so a sender owner, partner, or FlowRelay support can help safely.

- Guide: https://docs.flowrelay.app/use-cases/share-diagnostics-with-partner/
- Related setup: https://docs.flowrelay.app/recover/diagnostics/

### Let an agent investigate an event
Give an authorized agent enough context to inspect receipts and prepare approved recovery actions.

- Guide: https://docs.flowrelay.app/use-cases/agent-assisted-operations/
- Related setup: https://docs.flowrelay.app/agent-access/

## Docs Paths

### Start setup
- [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.
- [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/): Send synthetic data 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/): See how plan caps affect new intake and approved operations without hiding existing receipts.
- [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/): Start the support-code glossary.
- [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.

### Agent Access
- [Agent Access](https://docs.flowrelay.app/agent-access/): Create scoped, revocable access for authorized agents without exposing 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 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.
- [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.
- [FlowRelay Operator Skill](https://docs.flowrelay.app/agent-access/skills/): Install the FlowRelay Operator Skill for setup, receipt investigation, recovery, and support workflows.
- [Support and expansion requests](https://docs.flowrelay.app/agent-access/support-and-expansion-requests/): Let scoped agents submit structured support and expansion requests without bypassing support safeguards.

### Reference
- [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 include raw event bodies, endpoint secrets, authentication headers, HMAC values, Shopify tokens, Shopify sessions, database URLs, customer data, merchant incidents, or copied private logs in public examples.