> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perkstar.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Perkstar to Zapier

> Open the public Perkstar app, authorise one business with OAuth, and test a safe first Zap.

The official Perkstar app is available in Zapier's public App Directory. The
person connecting it signs in to Perkstar, chooses the intended business,
reviews the requested access, and approves the connection. Zapier never asks
the user to paste a Perkstar API key.

<Info>
  Start from the [official Perkstar listing on
  Zapier](https://zapier.com/apps/perkstar/integrations). It is marked **Beta**
  and is available without an invitation. A page or similarly named app that
  asks for a raw Perkstar API key is not the official connection flow.
</Info>

## Before you connect

* The Perkstar business is on Growth, Scale, Enterprise, or Franchise.
* You can sign in to both the intended Perkstar and Zapier accounts.
* Your Perkstar role can connect integrations for the business.
* At least one active loyalty card exists for card-based actions and filters.
* You know which Zap owner, destination apps, and customer fields the workflow
  will use.

<Note>
  One Zapier connection represents one Perkstar business. If you operate more
  than one business, create a separate connected account for each one. You can
  reuse the same connected account in multiple Zaps for that business; there is
  not a one-Zap-per-connection limit.
</Note>

## Connect the account

<Steps>
  <Step title="Open Perkstar in Zapier">
    Open the [Perkstar App Directory
    page](https://zapier.com/apps/perkstar/integrations), sign in to the Zapier
    account that will own the workflow, and choose a Perkstar trigger or action.
    You can instead open Zapier's **App connections**, select **Add
    connection**, and search for **Perkstar**.
  </Step>

  <Step title="Choose Sign in to Perkstar">
    Add a Perkstar trigger, action, or search and select **Sign in** when Zapier
    asks for a connected account. Zapier opens Perkstar's hosted authorisation
    page over HTTPS.
  </Step>

  <Step title="Choose the correct Perkstar business">
    Confirm the business name and account shown by Perkstar. If it is wrong,
    stop and switch account or organisation before approving. The resulting
    OAuth grant is tenant-scoped and cannot read or write another business.
  </Step>

  <Step title="Review and approve access">
    Read the plain-language permissions on the Perkstar consent screen. The app
    requests the access needed by its available triggers, actions, searches, and
    card selector. Perkstar returns a revocable OAuth grant to Zapier; no raw
    API key is displayed.
  </Step>

  <Step title="Name and test the connection">
    Give the connected account a name that identifies the business, for example
    `Perkstar — North Street Coffee`. Run Zapier's connection test and confirm
    the returned business is the one you intended.
  </Step>
</Steps>

The public Zapier listing gives access to the integration; it does not create a
Perkstar login. If you are joining an existing business, accept that business's
Perkstar team invitation first and then return to Zapier. If you do not yet use
Perkstar, create the business account and eligible plan before authorising the
connection.

## Build the first Zap

Start with a reversible or read-only workflow before sending customer messages
or changing loyalty balances.

<Steps>
  <Step title="Choose a trigger or search">
    Pick one named Perkstar trigger, or use **Find Customer** / **Find Enrolment
    or Pass** to prove the connection without changing data. The full list is in
    the [catalogue](/integrations/zapier/triggers-actions).
  </Step>

  <Step title="Select a card when offered">
    Card-aware steps load the active cards from the connected Perkstar business.
    Focused loyalty actions show only compatible programmes: Stamp/Multipass for
    Add Stamp or Visit, Points for Award Points, and Cashback/Discount for
    Record Purchase. Redeem Loyalty Balance supports Stamp, Points, Cashback,
    and Multipass balances; coupons, memberships, discounts, gift cards, and
    tickets use different flows. Select an explicit card when the business has
    several eligible programmes. Never paste a card name where a card ID is
    expected.
  </Step>

  <Step title="Test with a controlled record">
    Use an internal test customer whose data you are authorised to process. For
    an instant trigger, ask Zapier to test the trigger and perform the exact
    Perkstar event it is waiting for. For an action, verify the previewed inputs
    before running the test.
  </Step>

  <Step title="Inspect both systems">
    Confirm Zapier received the expected fields and, for a write, confirm the
    Perkstar customer, enrolment, transaction, or push result. A successful Zap
    step is not proof that a later destination step used the correct field.
  </Step>

  <Step title="Publish with a narrow audience">
    Turn the Zap on for one card or low-risk workflow first. Monitor Zapier Task
    History and the relevant Perkstar records before widening the audience.
  </Step>
</Steps>

When a workflow should continue after a search miss, use Zapier's explicit
**Find or Create Customer** or **Find or Enrol Customer in a Card** option. For
trigger enrichment, choose **Customer ID** in **Find Customer** and map the
trigger's `customerId`; this avoids a second identity guess from email or phone.

## Connection lifecycle

| Change                    | Effect                                                                                                                                                    |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Turn a Zap off            | Zapier stops the workflow and deletes its app-managed Perkstar instant-trigger subscription. Historical tasks remain under Zapier's retention settings.   |
| Remove an instant trigger | Zapier deletes the corresponding Perkstar webhook subscription. Re-enabling creates a fresh callback subscription and signing secret.                     |
| Reconnect the account     | Future steps use the renewed OAuth grant; stable subscription/action retries remain scoped to the same business grant. Test every enabled Zap afterwards. |
| Revoke Perkstar access    | API calls fail and owned instant subscriptions are paused until the account is reconnected or the Zap is recreated.                                       |
| Remove a destination app  | Perkstar cannot remove data already copied into that app. Delete or retain it under the business's own policy.                                            |

To revoke the connection from Perkstar, open **Settings → Authorised apps** for
the connected business and revoke Zapier. Then remove or reconnect the account
in Zapier before re-enabling any affected Zaps.

Read [Troubleshooting](/integrations/zapier/troubleshooting) before reconnecting
an account used by several live Zaps, and read [Data and security](/integrations/zapier/data-security)
before mapping personal data.

## Get support

For a problem in a Zap workflow, start with [Zapier
Support](https://zapier.com/app/get-help). That route includes the Zap and run
context Zapier needs for first-line troubleshooting; Zapier will escalate an
actionable Perkstar integration report to us when necessary. Contact [Perkstar
Support](mailto:support@perkstar.co.uk) directly when the OAuth page shows the
wrong Perkstar business or the issue concerns a Perkstar account, plan, team
invitation, or consent screen.

Before contacting support, keep the failed run in Zap history and note
the step name, approximate UTC time, Zap run/task ID, and any Perkstar
`X-Request-Id`. Redact customer data and never send passwords, OAuth tokens,
refresh tokens, or webhook target URLs.


## Related topics

- [Receive webhooks](/guides/webhooks.md)
- [Zapier troubleshooting](/integrations/zapier/troubleshooting.md)
- [Connect Perkstar to Make](/integrations/make/setup.md)
- [Zapier](/integrations/zapier/index.md)
- [Zapier data and security](/integrations/zapier/data-security.md)