Skip to main content

Documentation Index

Fetch the complete documentation index at: https://app.docs.circuly.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Circuly emits a set of Shopify Flow triggers so your team can automate workflows around subscription lifecycle events without writing any code. Pair a Circuly trigger with any Shopify-native action to tag customers, send emails, kick off fulfillment, post to Slack, segment for marketing, and more.
Shopify Flow is available on Shopify Plus stores. If your store is not on Plus, the trigger extension is installed but workflows will not run.

​
What is a trigger?

A trigger is the event that starts a Shopify Flow workflow. Circuly fires triggers automatically whenever the underlying event happens — for example, when a payment fails, when a subscription is paused, or when a rental asset is returned. The merchant configures what should happen in Shopify Flow. 
[ Circuly event ] → [ Trigger fires ] → [ Your Flow workflow runs ]

​
Setting up your first workflow

1

Open Shopify Flow

In your Shopify admin, go to Apps → Shopify Flow. If you don’t see Flow installed, install it from the Shopify App Store first (free for Plus stores).
2

Create a workflow

Click Create workflow, then Select a trigger.
3

Pick a Circuly trigger

Search for Circuly in the trigger list. Pick one of the 15 triggers — for example, Subscription paused.
4

Add conditions and actions

Add any Shopify-native actions: tag the customer, send an email, log to a Slack channel, etc. Use the trigger’s payload fields (customer, contract handle, amounts) inside conditions and template variables.
5

Turn the workflow on

Click Turn on workflow. Circuly will start sending events to it immediately.

​
What’s available today

  • 15 lifecycle triggers covering invoices, subscriptions, and rental assets — see Trigger reference.
  • Recipe library with worked examples you can copy — see Flow recipes.
subscription-ended is declared but not yet emitted. The trigger appears in the Flow editor, but Circuly does not currently fire it for fixed-term contract completion. Use subscription-cancelled for now and watch this page for updates.

​
Coming later

We’re starting with triggers because they unlock the most automation surface with the smallest risk. Flow actions (steps that call back into Circuly to pause, cancel, or skip a cycle) are on the roadmap but not in this release. Workflow templates and metafield exposure are also planned.

​
Troubleshooting

  • My workflow isn’t running. Confirm your store is on Shopify Plus and that the workflow is on (not draft). Check Flow’s run history for the trigger.
  • A field is missing in the payload. Trigger payloads are documented in Trigger reference. If a field you expect is empty, it means Circuly didn’t have a value at the moment the event fired.
  • The trigger doesn’t appear in Flow. Make sure the latest Circuly app version is installed. Flow extensions are deployed alongside the Circuly app.