Connectors

Voucherify

Run Voucherify promotions and loyalty — vouchers, campaigns, promotion tiers/stacks, the validate/redeem/rollback flow, customers, orders, products, and loyalty programs. Covers the header-pair auth schemes, the data-center base URL, and list/validation/redemption response shapes.

On this page

Connecting Voucherify How Voucherify actions are structured Reading the response Validate & Redeem (the core flow)Vouchers Campaigns Promotions Customers, Orders, Products Loyalties Rewards, Validation Rules, Segments, Categories, Metadata Schemas, Publications, Referrals, Locations, Templates, Bin, Events Generic Request Step Name Step Reference Execution Settings Caching Locking

Connecting Voucherify

Every action needs a Voucherify connection. Voucherify authenticates with a pair of headers, and the pair depends on which API surface you're using:

Server-side API (most of this connector) — X-App-Id + X-App-Token (from Project Settings → Application Keys).
Client-side API (the Client-side group) — X-Client-Application-Id + X-Client-Token.
Management API (the Management group — projects, users, roles, custom event schemas) — X-Management-Id + X-Management-Token.

These header names are fields on each action; set the right pair on the connection (or per-action via Additional Headers).

Set the Base URL. The spec's server is https://{cluster}.voucherify.io — use the Base URL field to enter your project's data-center host: https://api.voucherify.io (EU), https://us1.api.voucherify.io (US), or https://as1.api.voucherify.io (Asia).

How Voucherify actions are structured

Each action is one Voucherify operation, grouped in the picker by area: Vouchers, Campaigns, Promotions, Redemptions, Validations, Qualifications, Publications, Customers, Orders, Products, Product Collections, Rewards, Loyalties, Validation Rules, Segments, Categories, Events, Exports, Async Actions, Metadata Schemas, Locations, Referrals, Templates, Bin, Management, Client-side (plus Generic Request). Vouchers are addressed by their code (path parameter), campaigns and most other resources by id.

Reading the response

Every action's result is at {{<stepReference>.response...}} (see Step Reference): {{<stepReference>.response.status}}, {{<stepReference>.response.headers.<name>}}, and {{<stepReference>.response.data...}} for the body.

A single resource — fields are directly under data, e.g. {{get_voucher.response.data.code}}, {{get_voucher.response.data.active}}, {{get_voucher.response.data.gift.balance}}, plus {{<stepReference>.response.data.object}} naming the type.
A list — {{<stepReference>.response.data.<resource>}} (e.g. {{<stepReference>.response.data.vouchers}}, {{<stepReference>.response.data.campaigns}}) plus {{<stepReference>.response.data.total}}. Page with limit (max 100) + page, or starting_after (a timestamp cursor), via Additional Query Parameters.
Validation returns {{<stepReference>.response.data.valid}} (boolean) and {{<stepReference>.response.data.redeemables}} (each with its own status and calculated discount).
Redemption returns {{<stepReference>.response.data.redemptions}}, each with { id, result: "SUCCESS" | "FAILURE", voucher, order }.

A non-2xx response does not fail the step — Voucherify's error body ({{<stepReference>.response.data.code}}, {{<stepReference>.response.data.message}}, {{<stepReference>.response.data.details}}, {{<stepReference>.response.data.key}}) is returned with the real status. Async bulk operations return 202 with an async_action_id — poll it via the Async Actions group.

Validate & Redeem (the core flow)

Validate Stackable Discounts — POST /v1/validations. Body: redeemables (array of { object: "voucher" | "promotion_tier", id }), order ({ amount, items: [...] }), customer, session. Checks eligibility and returns the computed discount without consuming anything. Use at cart display.
Redeem Stackable Discounts — POST /v1/redemptions. Same body shape plus a session to make the redemption idempotent/lockable. Actually consumes the voucher / increments usage. Use at order placement.
List Redemptions / Get Redemption — GET /v1/redemptions, GET /v1/redemptions/{redemptionId}.
Rollback Redemption — POST /v1/redemptions/{redemptionId}/rollback (single) or POST /v1/redemptions/{parentRedemptionId}/rollbacks (a stacked set). Use on order cancellation/refund.
Get Voucher's Redemptions — GET /v1/vouchers/{code}/redemption.

Vouchers

GET /v1/vouchers (list), GET /v1/vouchers/{code} (get), POST /v1/vouchers/{code} (create with a specific code), POST /v1/vouchers (generate a random code), PUT /v1/vouchers/{code} (update), DELETE /v1/vouchers/{code}. Plus enable / disable, POST /v1/vouchers/{code}/balance (adjust a gift-card / loyalty-card balance), GET /v1/vouchers/{code}/transactions + export, bulk import (/import, /importCSV), and async bulk update (/bulk/async, /metadata/async).

Campaigns

GET|POST /v1/campaigns, GET|PUT|DELETE /v1/campaigns/{campaignId}. Plus POST /v1/campaigns/{campaignId}/vouchers (add N vouchers) / .../vouchers/{code} (add a specific one), import (/import, /importCSV), enable / disable, GET .../summary, and transactions list/export.

Promotions

Tiers — GET /v1/promotions/tiers (all) / .../{campaignId}/tiers, GET|PUT|DELETE /v1/promotions/tiers/{promotionTierId}, POST /v1/promotions/{campaignId}/tiers, enable / disable.
Stacks — GET /v1/promotions/stacks (all) / .../{campaignId}/stacks, GET|PUT|DELETE /v1/promotions/{campaignId}/stacks/{stackId}, POST /v1/promotions/{campaignId}/stacks.

Customers, Orders, Products

Customers — GET|POST /v1/customers, GET|PUT|DELETE /v1/customers/{customerId}, plus permanent deletion, activity, redeemables, and segment membership.
Orders — GET|POST /v1/orders, GET|PUT /v1/orders/{orderId}, plus import and export. Orders drive earning rules and order-based validation.
Products & Product Collections — full CRUD on /v1/products (and /v1/products/{productId}/skus) and /v1/product-collections; used in validation rules and discount scoping.

Loyalties

The largest group (~52 actions). Loyalty programs (/v1/loyalties), their reward assignments, earning rules, tiers, members (/v1/loyalties/{campaignId}/members — add, get, list, transactions, points balance, redeem/transfer points), points expiration, and pending-points bulk actions.

Rewards, Validation Rules, Segments, Categories, Metadata Schemas, Publications, Referrals, Locations, Templates, Bin, Events

CRUD / list operations for each — see the module in the action picker. Notable: Publications (/v1/publications) assigns a campaign's voucher to a specific customer; Qualifications (POST /v1/qualifications) returns every redeemable a given customer/order currently qualifies for; Events (POST /v1/events) tracks a custom event for earning rules.

Generic Request

Five actions — Generic GET / POST / PUT / PATCH / DELETE Request — for anything not surfaced as a dedicated action. Set the appropriate auth header pair.

path — required, relative to the Base URL, e.g. /v1/loyalties/camp_x/members/cust_y/transactions, /v1/async-actions/act_z.

Also applies here

Step Name

What it's for

Every step in a workflow gets a name — either one you set or a default based on the connector and action (e.g. "Get Order Details", "Send Welcome Email"). It's shown throughout the UI and in your execution history, and it's also the source for the step's Reference — a camelCase identifier auto-generated from the name (e.g. "Get Order Details" → getOrderDetails) — which is what you actually use in {{...}} expressions to read this step's output from later steps. See Step Reference.

Rules

Must be at least 2 characters, and 50 characters or fewer.
Must be unique within the workflow — reusing a name that's already taken will be rejected, with a suggested alternative (e.g. "Get Order Details 2").
Can't be empty.

Tips

Prefer a descriptive, human-readable name over a generic one — "Get Order Details" is easier to work with later than "HTTP Request 2", especially once a workflow has a dozen steps.
Renaming a step updates every reference to it elsewhere in the workflow automatically.

Step Reference

Syntax

Any input field can reference earlier data using {{expression}}. The expression is evaluated as JSONata — so simple dot-paths and more advanced queries (filters, functions) both work.

Referencing a step's output

Use the step's Reference — a camelCase identifier auto-generated from its Name (e.g. "Get Order Details" → getOrderDetails), shown read-only wherever the step's fields are configured — followed by the field path. Elsewhere in these docs this general pattern is written as {{<stepReference>.field.path}}:

{{getOrderDetails.response.data.id}}
{{getOrderDetails.response.status}}

The raw display name won't work here even though it's what you see in the UI — {{Get Order Details.response.data.id}} isn't valid, since a bare name containing spaces isn't a single JSONata identifier. Always use the camelCase Reference.

You can also reference steps by position instead of by reference:

{{steps[0].response.data.id}}

Referencing trigger data

{{trigger.headers.authorization}}
{{trigger.body.customerId}}
{{trigger.query.page}}
{{trigger.params.orderId}}
{{trigger.method}}
{{trigger.path}}

Referencing workflow variables

{{variables.myVariable}}

See Variables for the full list of variable types and more examples, including connection-type variables.

Referencing runtime variables

A separate, mutable namespace written by the Variable connector while a run is in progress — not the same as the workflow-level variables above:

{{runtimeVariables.myVariable}}

Notes

If an expression can't be resolved (a typo in a step name, a field that doesn't exist), it resolves to an empty string rather than failing the workflow — check your execution history if a value comes through blank.
Object values are automatically JSON-stringified when interpolated into a string field.

Execution Settings

Fire-and-forget

When enabled, the workflow doesn't wait for this step to complete before moving to the next one. Use it for steps whose result nothing downstream depends on — logging, analytics, notifications — so they don't add latency to the steps that matter.

Continue on error

When enabled, a failure in this step doesn't stop the workflow — execution continues to the next step. The failure is still recorded in the execution history; this just controls whether it's fatal.

Combine the two for steps that are genuinely optional to the outcome: fire-and-forget so they don't add latency, continue-on-error so a failure in them (e.g. an analytics endpoint being briefly down) doesn't take down an otherwise-successful workflow run.

Caching

What it does

When enabled, a step's result is cached for a configurable TTL (time-to-live, in seconds). If the step runs again with the same effective cache key before the TTL expires, the cached result is returned instead of re-running the step.

Configuring it

Enabled — turn caching on or off for this step.
TTL — how long (in seconds) a cached result stays valid.
Cache key template — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same call". By default this is based on the step's resolved input; a custom template lets you cache more narrowly or broadly than that.

When to use it

Good candidates are steps that call something slow or rate-limited but return the same answer for the same input within a short window — a lookup against a rarely-changing external system, for example. Skip it for steps whose result must always be fresh (anything involving live inventory, pricing, or payment state).

Locking

What it does

When enabled, only one execution of this step (for a given lock key) can run at a time. If a second execution tries to run the same step while a lock is held, it waits until the lock is released or the hold period elapses.

Configuring it

Enabled — turn locking on or off for this step.
Lock key — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same resource". By default the lock is scoped to the step itself; a custom key lets you lock per-customer, per-order, or any other identifier that needs serialized access.
Period — how long (in seconds) the lock is held before it's automatically released, in case an execution doesn't complete normally.

When to use it

Use it whenever concurrent executions could race on the same resource — e.g. two workflow runs both trying to update the same order's status at once. A lock key scoped to the order id ensures only one of them proceeds at a time.