Skip to content

Send a test flow event

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

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

Costs 2 rate-limit points · Rate limits

Send a test event to Klaviyo (klaviyo_email, klaviyo_sms) or Postscript (postscript), so the merchant can build or test the flow that sends STOQ alerts. The event carries a sample product and customer, not real store data.

sent is the provider's answer; when false, error_message says why (e.g. not connected).

Also searched assend klaviyo test eventsend dummy eventssend postscript test event

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

    Send the event for this template.

  • metric_namestring

    klaviyo_email: the Klaviyo metric to send.

Returns

  • channelstring
    Example: klaviyo_email
  • sentboolean
    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/send_test_event
curl -X POST "https://app.stoqapp.com/api/v2/external/account/integrations/{channel}/flows/send_test_event" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metric_name": "Preorder shipping update (STOQ)"
  }'
Response
{
  "channel": "klaviyo_email",
  "sent": true
}