Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Flow trigger API

Start your Shopify Flow workflows from your own server with the Shopwaive HTTP POST trigger and the Flow trigger API (2026-11)

POST /api/trigger starts every Shopify Flow workflow in your store that begins with the Shopwaive HTTP POST trigger. Use it when your CRM or your server should decide in Flow what happens next, for example a deposit with the Shopwaive Increment balance action.

Send your Shopwaive API key in the X-Shopwaive-Access-Token header. The key needs Change balances through the REST API (wallets:write). Send an Idempotency-Key header with every request: see Retry safely. This request does not need the X-Shopwaive-Platform header.

Base URL: https://app.shopwaive.com

Start your Shopify Flow workflows

post

Starts every Shopify Flow workflow in your store that begins with the Shopwaive HTTP POST trigger. The fields you send become the trigger's variables in Flow. Every field is optional.

This request does not need the X-Shopwaive-Platform header.

Send an Idempotency-Key header with a new value for each request. The same key again gets the first answer and does not start the workflows again. Without the header, a request made with a Shopwaive API key returns 400 idempotency_key_required and starts nothing.

Authorizations
X-Shopwaive-Access-TokenstringRequired

Your Shopwaive API key. Create it in the Shopwaive app under Settings > Develop > Shopwaive API keys. It starts with swak_.

Header parameters
Idempotency-Keystring · min: 1 · max: 255Required

Required with a Shopwaive API key. A key you choose for this request: 1 to 255 printable ASCII characters, with no space at either end. A UUID is a good choice. Use a new key for each request, and send the same key again to retry: Shopwaive answers with the first answer and does not start the workflows again. Without it, the request returns 400 idempotency_key_required and starts nothing.

Example: 3f9c2b8e-1d4a-4c7e-9b2f-6a1e5d0c7b3a
Body

Every field is optional. Each one becomes the HTTP POST trigger's variable of the same name in Shopify Flow.

emailstringOptional

The customer's email address.

customeridstringOptional

A Shopify customer id.

orderidstringOptional

A Shopify order id.

productidstringOptional

A Shopify product id.

lineitemidstringOptional

An order line id.

collectionidstringOptional

A collection id, or several separated by commas.

sourcestringOptional

Where the request comes from, for example a URL.

referencestringOptional

Any reference from your CRM or server.

authorizedbooleanOptional

Always reaches Flow as true: a false value is dropped and the default true is sent. For a true or false condition, use enabled.

Default: true
numbernumberOptional

A number for your workflow's conditions. 0 if you leave it out.

Default: 0
datestringOptional

A date as text, for example an ISO date. The time of the request if you leave it out.

previousnumberOptional

For reference only. Changes no balance.

transactionnumberOptional

For reference only. Changes no balance.

availablenumberOptional

For reference only. Changes no balance.

segmentstringOptional

A Shopify customer segment query, for a Shopwaive action later in the workflow.

notestringOptional

A note or title for a Shopwaive action later in the workflow.

expirationstringOptional

An expiry date as text, for example 2028-04-25.

mediastringOptional

A media link for a Shopwaive action later in the workflow.

recipientstringOptional

An email address for a later action such as Send email.

recipientnamestringOptional

A recipient's name for a later action.

templatestringOptional

An email template name for a later Shopwaive email action.

enabledbooleanOptional

A true or false value for your workflow. false if you leave it out.

Default: false
eventstringOptional

Any text for your workflow.

pointsnumberOptional

A number for your workflow. 0 if you leave it out.

Default: 0
referralstringOptional

Any text for your workflow, for example a referral code.

typestringOptional

Any text for your workflow.

variantstringOptional

Any text for your workflow.

limitstringOptional

Any text for your workflow.

versionstringOptional

Any text for your workflow.

stylestringOptional

Any text for your workflow.

titlestringOptional

Any text for your workflow.

groupstringOptional

Any text for your workflow.

gidstringOptional

Any text for your workflow.

Responses
200

The trigger was queued for Shopify Flow. The body is an empty object.

application/json
Responseobject
post/api/trigger
POST /api/trigger HTTP/1.1
Host: app.shopwaive.com
X-Shopwaive-Access-Token: swak_YOUR_API_KEY
Idempotency-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "email": "customer@example.com",
  "reference": "crm-12345",
  "authorized": true,
  "number": 10,
  "note": "Signed up at the event"
}
{}

Request body

Every field is optional. Each one becomes the trigger's variable of the same name in Flow.

key
type
value

email

text

The customer's email address

customerid

text

A Shopify customer id

orderid

text

A Shopify order id

productid

text

A Shopify product id

lineitemid

text

An order line id

collectionid

text

A collection id, or several separated by commas

source

text

Where the request comes from, for example a URL

reference

text

Any reference from your CRM or server

authorized

true or false

Always reaches Flow as true: a false value is dropped. For a true or false condition, use enabled.

number

number

For your workflow's conditions. 0 if you leave it out.

date

text

A date, for example an ISO date. The time of the request if you leave it out.

previous, transaction, available

number

For reference in Flow only. They change no balance.

segment

text

A Shopify customer segment query, for a Shopwaive action later in the workflow

note

text

A note or title for a Shopwaive action later in the workflow

expiration

text

An expiry date, for example 2028-04-25

media

text

A media link for a Shopwaive action later in the workflow

recipient, recipientname

text

An email address and a name for a later action such as Send email

template

text

An email template name for a later Shopwaive email action

enabled

true or false

For your workflow. false if you leave it out.

points

number

For your workflow. 0 if you leave it out.

event, referral, type, variant, limit, version, style, title, group, gid

text

Any text for your workflow

Send each field as the type in the table. Flow reads the variables with these types.

Answer

HTTP 200 with an empty object {} means the trigger was queued for Shopify Flow. Your workflows then run in Shopify Flow.

Retry safely

Send an Idempotency-Key header with every request: 1 to 255 printable ASCII characters with no space at either end, a new value for each request (a UUID is a good choice). The same key again gets the first answer, with Idempotent-Replayed: true, and does not start the workflows again. To start the workflows twice on purpose, send each request with its own key. A request made with a Shopwaive API key and no Idempotency-Key returns HTTP 400 with the reason idempotency_key_required, and starts nothing.

To set up the workflow in Shopify Flow, see Shopify Flow in the Help Center.

Last updated