Skip to main content

Integrations

Connect Perkstar with third-party apps, access the API, and configure webhooks.

Written by Dan. A
Updated this week

Overview

The Integrations section lets you connect Perkstar with third-party platforms like POS systems, CRMs, and no-code tools. You can use the API to build custom integrations, connect pre-built apps, and set up webhooks to send real-time data to external systems.

Important: Integrations are only available on the Scale plan.


How to access integrations

  1. Navigate to Settings in the left-hand menu.

  2. Click the Integrations tab at the top.

The screen starts with a tile showing your current plan and the number of integrations it allows.


API key

Your API key is displayed in the Integrations section. Use it to connect Perkstar with third-party platforms.

  • Click Copy to copy the API key to your clipboard

  • For full API documentation, visit docs.perkstar.co.uk

The API documentation includes all available methods for integration. If you need additional methods, contact support and they can be added.


App setup

The App Setup section displays pre-built integrations available in the marketplace. These include no-code platforms such as Zapier and Make (formerly Integromat).

To connect an app, click Install on the relevant row.


Active integrations

The Active Integrations section lists all currently connected integrations with details including name, Integration ID, date, status, and details.


Active apps

The Active Apps section lists all apps you've connected, with columns including name, Template ID, accrual rule, and delivery channels.


Webhooks

Webhooks let you send real-time data to external systems when specific events happen in Perkstar (e.g., a card is installed, a transaction is processed, or a customer changes RFM segment).

To set up a webhook:

  1. Navigate to Settings in the left-hand menu.

  2. Click the Webhooks tab.

  3. Enter the URL where you want data sent.

  4. Enable sending webhooks.

  5. Select the events you want to trigger the webhook (e.g., card installation).

  6. Click Save.

If you need additional webhook events beyond what's currently available, contact support and they can be added.


FAQs

Which plan includes integrations?

Integrations are only available on the Scale plan.

Where can I find the API documentation?

Visit docs.perkstar.co.uk for the full API documentation, including all available methods.

What platforms can I integrate with?

Pre-built integrations include no-code platforms like Zapier and Make. You can also build custom integrations using the API, or connect any external system using webhooks.

Can I request additional API methods or webhook events?

Yes. Contact support with your requirements and additional methods or events can be added.

What's the difference between integrations and webhooks?

Integrations connect Perkstar directly with third-party platforms using the API. Webhooks send real-time notifications to a URL of your choice when specific events happen β€” useful for triggering actions in external tools without building a full integration.

Did this answer your question?