Open Perkstar in Zapier’s App
Directory to use this
catalogue without an invitation. The app is in public Beta, so event payloads
can gain new optional fields; map only the fields your Zap needs.
Instant triggers
The integration defines one named Zapier trigger for each real business event below. The diagnosticwebhook.test event is deliberately excluded from the Zapier
catalogue.
Customer lifecycle
The lifecycle-group trigger does not represent an operator-created saved
segment. Perkstar stores a customer’s first classification as a baseline and
does not emit it, preventing a newly connected Zap from receiving every
existing customer.
Wallet, scanner, expiry, and referrals
referral.created is customer-to-customer loyalty activity. It is not a
merchant, agency, or partner-referral event.
The first group-change or Google-install trigger in a business establishes a
no-event baseline on the next completed periodic sweep. Tracking begins after that
warm-up; Apple installs remain callback-driven, and post-subscription expiries
retain their effective expiry time while waiting for projection.
The five trigger records flatten these event fields for later Zap steps:
Loyalty activity
Tickets, gifts, and multipasses
Memberships
Engagement
Bookings
The official app accepts the event at its unique Zapier REST Hook URL and then
exposes a mapping-friendly record:
For booking events, the raw
data.id is exposed as resource_id so it cannot
replace the trigger’s primary id. See the webhook event catalogue
for required, optional, and nullable event fields. The app keeps documented
optional mapping fields present with null when the live event omits them, but
does not enrich every trigger with a customer profile. Add Find Customer
only when the event carries a customer ID and the Zap needs current contact
fields.
Trigger options
- Card (Optional) is available on every named trigger except Customer Anonymised, Customer Lifecycle Group Changed, and Automation Fired. Leaving it blank accepts the event from every card.
- Include Test Events appears on New Loyalty Transaction and Reward Redeemed. It is off by default so test API activity cannot start live downstream steps; enable it only in a dedicated test Zap.
Actions
Non-idempotent write actions use deterministic idempotency keys; customer updates are naturally repeatable PATCHes. Loyalty activity and Wallet pushes require the source app’s stable transaction or event ID; use a real record ID rather than a timestamp or random value. Perkstar automatically namespaces each loyalty source ID by Zapier action and activity type. Retrying the same action and source ID remains safe, while reusing an order ID for a different loyalty operation cannot replay the wrong transaction. References that would exceed the API’s 180-character limit use a deterministic SHA-256 form. Every POST-based Zapier action checks the current OAuth credential before it looks for an earlier response. Refreshing the access token for the same Perkstar connection preserves retry protection, while a revoked connection is denied instead of replaying an earlier success. The four focused loyalty actions provide guided fields for common merchant jobs. Record Loyalty Activity remains available for workflows that need to choose the activity type dynamically. Each source transaction ID is permanently bound to its first canonical customer, card, operation, and amount. An exact Zapier retry returns the original result; reusing that ID with different inputs stops with a conflict instead of silently returning or changing the first transaction. All four focused loyalty actions and Record Loyalty Activity include Create Customer If Missing, which defaults off. Leave it off when the workflow should reward only existing members. Turn it on deliberately when a lookup miss should create the customer and enrol them in the selected card before applying the loyalty write. A missing or cross-business Customer ID is never treated as permission to create a replacement customer.Action inputs
The loyalty action accepts the wire-level activity types supported by the
public endpoint:
STAMP, REDEEM, CHECK_IN, DISCOUNT, and POINTS.
DISCOUNT requires a positive amount in integer minor units. POINTS requires
either a balance change (up to two decimal places) or a positive purchase
amount. The selected card’s type determines which values are valid.
Send Wallet Push supports {firstName}, {lastName}, {balance},
{cardName}, {installLink}, {shareLink}, and {orgName} merge fields. Map
the originating trigger’s stable id into Source Event ID so a retry of the
same source event is collapsed within Perkstar’s 24-hour idempotency window.
Searches
Search-or-Create relationships
Zapier exposes both relationships explicitly, so a workflow can branch on a search miss without constructing a custom API step:
The enrolment pair still requires a customer and card. Repeatedly selecting the
same customer/card pair returns the existing active enrolment rather than
creating a duplicate. Perkstar never undoes an inactive or revoked status
implicitly: if the Active search misses but the create step finds that status,
the action halts with instructions to review the enrolment.
The app uses hidden dynamic-field helpers that paginate through up to ten pages
of 200 cards (2,000 total) before filtering. General selectors show every active
card; Add Stamp or Visit shows only Stamp and Multipass cards, Award Points only
Points cards, Record Purchase only Cashback and Discount cards, and Redeem
Loyalty Balance only Stamp, Points, Cashback, and Multipass cards. These helpers
are not advertised as standalone actions. A mapped Card ID is still checked
when the focused action runs, so mapping an incompatible card does not bypass
the selector.
Searches return current API state, while a trigger contains the event snapshot
produced at the time of the business change. If a Zap must preserve the exact
event context, store the trigger values before running later searches.
Behavior the app does not expose
- No action edits card configuration, rewards, tiers, coupons, or orders.
- No action bypasses Perkstar consent, plan, card-type, tenant, or rate-limit checks.
webhook.testis not a customer-facing Zapier trigger.- A trigger does not promise customer email, name, or phone unless that field is part of the documented event payload.
- Searches do not scan another Perkstar business connected to the same Zapier account.