Skip to content

Verify flow setup

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

POST/account/integrations/{channel}/flows/verify

Costs 2 rate-limit points · Rate limits

Check with the provider that the flows sending STOQ alerts are set up: Klaviyo email (klaviyo_email), Klaviyo SMS (klaviyo_sms) or Postscript (postscript). Returns verified and, when not, the provider's reason.

template_id checks one template's flow (needed for klaviyo_sms); without it klaviyo_email checks every back-in-stock template's flow. setting_flow true with flow_name and flow_type checks a settings flow (klaviyo_email). verified false is a real answer, not an error.

Also searched asverify klaviyo flowcheck klaviyo flowverify postscript setupis my klaviyo flow working

Path parameters

  • channelstringRequired

    The integration channel whose flows to act on: klaviyo_email, klaviyo_sms or postscript.

Headers

  • Idempotency-Keystring

    A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • template_idinteger

    A template id from GET /back_in_stock/templates.

  • flow_namestring

    Name of the flow in Klaviyo to check; required when setting_flow is true.

  • flow_typestring

    With setting_flow, which preorder flow to check, the shipping update or the payment failed flow.

    One of shipping_updatepayment_failed
  • setting_flowboolean

    For klaviyo_email, check a preorder shipping update or payment failed flow named by flow_name and flow_type instead of a template's flow.

    Default false

Returns

  • channelstring
    Example: klaviyo_email
  • verifiedboolean
    Example: true
  • error_messagestring

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

POST/account/integrations/{channel}/flows/verify
curl -X POST "https://app.stoqapp.com/api/v2/external/account/integrations/{channel}/flows/verify" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": 18452,
    "flow_name": "Back in stock alert (STOQ)"
  }'
Response
{
  "channel": "klaviyo_email",
  "verified": true
}