All docs pages

START

USE CASES

SET UP

OPERATE

RECOVER

AGENT ACCESS

REFERENCE

Current edition: Shopify Flow

FlowRelay Docs for Shopify Flow

Set up your first endpoint, read receipts, recover safely, and give a partner or agent controlled access. Start with the path that matches your job.

Choose your path

External events into Shopify Flow

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

Overview Quickstart

Recover a failed handoff

Use receipts, support codes, and replay controls when an event needs attention.

Overview Support codes

Agent Access

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

Overview Set up 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 Swapover guide

Setup

First endpoint guide Create one endpoint, connect the matching Shopify Flow trigger, send one safe test event, and confirm the receipt before production traffic. Create an endpoint Create the sender-facing URL and choose the event type Shopify Flow should receive. Authenticate requests Choose HMAC-SHA256 or static-header authentication without exposing secrets. Event types and payloads Choose the Shopify Flow trigger variant and required payload field paths your sender can support. 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 Use the field-by-field reference when choosing trigger variants or configuring mapping paths. Add the Shopify Flow trigger Enable the FlowRelay trigger that receives the event in Shopify Flow. Send your first test event After the endpoint and matching Flow trigger are ready, send a safe test event and confirm one Delivered receipt.

Operate

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

Recover

Support codes Look up a support code and what to do next. Retries, replay, and resend Separate sender retries, FlowRelay processing reconciliation, and deliberate replay. Replay an event Preview side effects before a recovery replay. Duplicates and idempotency Understand duplicate suppression and action idempotency before resending or replaying. Share diagnostics Send redacted evidence to support or a partner. Work with support Use receipts, diagnostics, and redacted support summaries when FlowRelay support needs evidence.

Swap over

Swap over to FlowRelay Replace a brittle webhook, custom-code, or manual event path with a safe pilot and rollback plan. Plan a safe endpoint swap Inventory current lanes, choose one safe pilot, check plan fit, and prepare rollback.

Agent Access

Agent Access Authorize an agent through scoped, revocable grants without handing over broad store authority. Grants and scopes Compare authority tiers, expiration choices, revocation, audit, and hard boundaries. Agent and API rate limits Use 429 fields, Retry-After, and grouped rate-limit families to keep automated work safe. Availability and refusals Understand how capabilities, scopes, object state, usage limits, and safety rules decide what an agent can do. Agent orientation Give authorized agents the right docs, Markdown pages, OpenAPI, CLI, skills, and MCP Agent Operations 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 Create one endpoint, prove one delivered test event, and stop before human-only steps. Shopify Sidekick Use Shopify Sidekick inside Admin for compact FlowRelay reads and merchant-confirmed FlowRelay action screens. FlowRelay Operator Skill Install the FlowRelay Operator Skill for setup, receipt investigation, recovery, and support workflows. Support, expansion, and feature requests Route support issues, future-edition demand, and FlowRelay feature requests without bypassing review safeguards.

Reference

Glossary Plain-language meanings for receipts, Delivered, support codes, replay, grants, and usage terms. Agent Operations API Use the canonical machine contract for scoped reads and action previews. CLI Run npx flowrelay-agent for docs discovery, doctor checks, JSON reads, and action previews. MCP Use MCP Agent Operations access over the same scoped Agent Operations contract when it is enabled. Action previews Describe preview, confirmation, idempotency, and audit structure. OpenAPI Expose schema and machine-readable contract locations.