Shopify Flow

Cardigan integrates with Shopify Flow, letting you react to gift card events and perform gift card operations as part of your own automated workflows.

This is the most flexible part of Cardigan. Anything Flow can connect to - Slack, email, your ERP, a custom HTTP endpoint - can be driven by a Cardigan event, or can drive a Cardigan operation.

Triggers

Triggers start a Flow workflow when something happens in Cardigan.

Issued card status changed

Runs whenever an issued card moves from one status to another.

The workflow receives:

• Status change - the previous status and the new status. Statuses are pending, scheduled, provisioning, provisioned, failed and cancelled.
• Issued card - the full card record, including its amount and currency, card type (digital or physical), source, the Shopify order and transaction it came from, its recipient metadata, provider details, and any failures recorded against it.

Because you receive both the previous and new status, you can distinguish a card that has just been provisioned from one that has been retried, or catch only the transition into failed.

Redeemed card status changed

Runs whenever a redemption moves from one status to another. Statuses are pending, redeeming, redeemed, failed and cancelled.

The workflow receives the status change and the full redemption record, including the amount, the Shopify order name and ID, the payment and transaction IDs, the card involved, and any failures.

Actions

Actions let a Flow workflow perform a gift card operation through Cardigan.

Get card balance

Looks up a card's balance with your provider.

Returns whether the lookup succeeded and, if so, the card's balance, status and expiry date.

Redeem card

Attempts to redeem a card for a specified amount.

Returns whether the redemption succeeded.

Example workflows

Provision cards after a manual check

If you've set your provisioning trigger to fire on an order tag, Flow is what applies that tag.

Build a workflow triggered by Shopify's Order created trigger, add whatever checks your business requires - an order value threshold, a fraud analysis condition, a wait step, an approval via an external system - and finish with Shopify's Add order tags action applying your configured trigger tag.

Cardigan sees the tag and provisions the cards. This lets you gate gift card issuance behind any workflow you can express in Flow.

Alert your team when a card fails to provision

Trigger on Issued card status changed, add a condition that the new status is failed, and finish with a Slack message or email containing the card's recipient details and the failure message.

This complements Cardigan's own notifications, which are batched hourly - use Flow when you want a specific failure surfaced immediately, or routed somewhere other than email.

Follow up with a customer when their card is ready

Trigger on Issued card status changed, condition on the new status being provisioned and the card type being digital, and send a follow-up message to the recipient.

Useful where you want your own branded communication alongside the delivery your provider sends, particularly for scheduled cards that arrive some time after the original order.

Check a balance during a support workflow

Use the Get card balance action inside a workflow triggered by something in your own systems - a support ticket tag, a scheduled check on outstanding corporate cards - and route the result wherever your team will see it.

Enabling triggers

Cardigan's triggers only send events once you have a Flow workflow using them.

Shopify notifies Cardigan when a workflow using one of its triggers is enabled or disabled, and Cardigan starts or stops emitting the relevant events accordingly. There's nothing to configure in Cardigan itself - build the workflow in Flow, turn it on, and events start arriving.