# FlowRelay Docs

> Public documentation index for FlowRelay. Fetch individual Markdown pages when an agent needs full page context.

Canonical docs origin: https://docs.flowrelay.app
Official product page: https://flowrelay.app/shopify-flow/

## Quick answer

FlowRelay for Shopify Flow receives authenticated external events from outside systems, records receipt facts and replay context, and hands normalized triggers to Shopify Flow without replacing Shopify Flow.

## Start
- [Docs home](https://docs.flowrelay.app/) ([Markdown](https://docs.flowrelay.app/index.md))
- [Overview](https://docs.flowrelay.app/getting-started/) ([Markdown](https://docs.flowrelay.app/getting-started.md))
- [Send your first test event](https://docs.flowrelay.app/getting-started/first-event/) ([Markdown](https://docs.flowrelay.app/getting-started/first-event.md))

## Use cases
- [External events into Shopify Flow](https://docs.flowrelay.app/use-cases/external-events-to-shopify-flow/) ([Markdown](https://docs.flowrelay.app/use-cases/external-events-to-shopify-flow.md))
- [Recover a failed handoff](https://docs.flowrelay.app/use-cases/recover-failed-handoff/) ([Markdown](https://docs.flowrelay.app/use-cases/recover-failed-handoff.md))
- [Work with a partner without sharing secrets](https://docs.flowrelay.app/use-cases/share-diagnostics-with-partner/) ([Markdown](https://docs.flowrelay.app/use-cases/share-diagnostics-with-partner.md))
- [Let an agent investigate an event](https://docs.flowrelay.app/use-cases/agent-assisted-operations/) ([Markdown](https://docs.flowrelay.app/use-cases/agent-assisted-operations.md))

## Setup
- [Create an endpoint](https://docs.flowrelay.app/setup/endpoints/) ([Markdown](https://docs.flowrelay.app/setup/endpoints.md))
- [Authenticate requests](https://docs.flowrelay.app/setup/authentication/) ([Markdown](https://docs.flowrelay.app/setup/authentication.md))
- [Event types and payloads](https://docs.flowrelay.app/setup/event-types-and-payloads/) ([Markdown](https://docs.flowrelay.app/setup/event-types-and-payloads.md))
- [Trigger variants and event mapping](https://docs.flowrelay.app/setup/trigger-variants-and-event-mapping/) ([Markdown](https://docs.flowrelay.app/setup/trigger-variants-and-event-mapping.md))
- [Rotate credentials](https://docs.flowrelay.app/setup/rotate-credentials/) ([Markdown](https://docs.flowrelay.app/setup/rotate-credentials.md))
- [Add the Shopify Flow trigger](https://docs.flowrelay.app/setup/shopify-flow-trigger/) ([Markdown](https://docs.flowrelay.app/setup/shopify-flow-trigger.md))

## Operate and recover
- [Read receipts](https://docs.flowrelay.app/operate/receipts/) ([Markdown](https://docs.flowrelay.app/operate/receipts.md))
- [Event history](https://docs.flowrelay.app/operate/event-history/) ([Markdown](https://docs.flowrelay.app/operate/event-history.md))
- [Event lifecycle](https://docs.flowrelay.app/operate/event-lifecycle/) ([Markdown](https://docs.flowrelay.app/operate/event-lifecycle.md))
- [Retention](https://docs.flowrelay.app/operate/retention/) ([Markdown](https://docs.flowrelay.app/operate/retention.md))
- [Usage limits](https://docs.flowrelay.app/operate/usage-limits/) ([Markdown](https://docs.flowrelay.app/operate/usage-limits.md))
- [Support codes](https://docs.flowrelay.app/recover/error-codes/) ([Markdown](https://docs.flowrelay.app/recover/error-codes.md))
- [Retries, replay, and resend](https://docs.flowrelay.app/recover/retries-replay-and-resend/) ([Markdown](https://docs.flowrelay.app/recover/retries-replay-and-resend.md))
- [Replay an event](https://docs.flowrelay.app/recover/replay/) ([Markdown](https://docs.flowrelay.app/recover/replay.md))
- [Duplicates and idempotency](https://docs.flowrelay.app/recover/duplicates-and-idempotency/) ([Markdown](https://docs.flowrelay.app/recover/duplicates-and-idempotency.md))
- [Share diagnostics](https://docs.flowrelay.app/recover/diagnostics/) ([Markdown](https://docs.flowrelay.app/recover/diagnostics.md))
- [Work with support](https://docs.flowrelay.app/recover/support-signals/) ([Markdown](https://docs.flowrelay.app/recover/support-signals.md))

## Agent access and reference
- [Agent Access](https://docs.flowrelay.app/agent-access/) ([Markdown](https://docs.flowrelay.app/agent-access.md))
- [Grants and scopes](https://docs.flowrelay.app/agent-access/grants-and-scopes/) ([Markdown](https://docs.flowrelay.app/agent-access/grants-and-scopes.md))
- [Agent orientation](https://docs.flowrelay.app/agent-access/agent-orientation/) ([Markdown](https://docs.flowrelay.app/agent-access/agent-orientation.md))
- [Agent mission playbooks](https://docs.flowrelay.app/agent-access/agent-mission-playbooks/) ([Markdown](https://docs.flowrelay.app/agent-access/agent-mission-playbooks.md))
- [Availability and refusals](https://docs.flowrelay.app/agent-access/availability-and-refusals/) ([Markdown](https://docs.flowrelay.app/agent-access/availability-and-refusals.md))
- [FlowRelay Operator Skill](https://docs.flowrelay.app/agent-access/skills/) ([Markdown](https://docs.flowrelay.app/agent-access/skills.md))
- [Raw FlowRelay Operator Skill](https://docs.flowrelay.app/agent-access/skills/flowrelay-operator/SKILL.md)
- [API reference](https://docs.flowrelay.app/reference/api/) ([Markdown](https://docs.flowrelay.app/reference/api.md))
- [CLI reference](https://docs.flowrelay.app/reference/cli/) ([Markdown](https://docs.flowrelay.app/reference/cli.md))
- [MCP reference](https://docs.flowrelay.app/reference/mcp/) ([Markdown](https://docs.flowrelay.app/reference/mcp.md))
- [Action previews](https://docs.flowrelay.app/reference/action-intents/) ([Markdown](https://docs.flowrelay.app/reference/action-intents.md))
- [OpenAPI](https://docs.flowrelay.app/reference/openapi/) ([Markdown](https://docs.flowrelay.app/reference/openapi.md))
- [Agent Operations OpenAPI JSON](https://docs.flowrelay.app/reference/openapi/agent-operations.openapi.json)

## Agent orientation
1. Start at this index.
2. Read the specific Markdown page for the task.
3. Use /agent/v1/manifest for edition identity, capability metadata, safety boundaries, and canonical docs URLs.
4. Use OpenAPI for exact contracts.
5. For endpoint create or edit work, read Trigger variants and event mapping before choosing triggerVariant or resource path fields.
6. Use Agent mission playbooks to translate the operator's goal into context reads and safe actions.
7. Use Availability and refusals to decide whether a capability is allowed by scope, usage, target state, safety, and product boundary.
8. Use the FlowRelay Operator Skill for controlled setup, receipt investigation, recovery, diagnostics, support, and API/CLI/MCP selection.
9. Use the CLI, or MCP Agent Operations access when enabled, only through the same scoped Agent Operations grant.
10. Check Usage limits and /agent/v1/plan-usage before broad reads, polling, or repeated action previews.

## Copy-paste starts
- API manifest: `curl https://api.flowrelay.app/agent/v1/manifest`
- CLI docs: `npx flowrelay-agent docs --base-url https://api.flowrelay.app`
- CLI doctor with grant: `FLOWRELAY_AGENT_BASE_URL=https://api.flowrelay.app FLOWRELAY_AGENT_TOKEN=$FLOWRELAY_AGENT_TOKEN npx flowrelay-agent doctor`
- MCP endpoint: `https://api.flowrelay.app/agent/v1/mcp` with `Authorization: Bearer $FLOWRELAY_AGENT_TOKEN`
- Operator Skill source: https://docs.flowrelay.app/agent-access/skills/flowrelay-operator/SKILL.md

FlowRelay is built from the ground up for agent operations: authorized agents use receipts, scoped grants, action previews, redaction, and audit instead of raw event bodies, secrets, and guesswork.

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