HeldSway

Integrations

Connecting HeldSway to Shopify, WooCommerce, Stripe, and more.

Overview of HeldSway Integrations

Reading time: 3 min by HeldSway Team

HeldSway connects with your existing store, rental software, and automation tools — so affiliate tracking works automatically without rebuilding your tech stack.

Supported Integrations

Category Supported Platforms
eCommerce & Rentals WooCommerce, WordPress, RentMy
Automation Zapier
Custom / Developer REST API

How Integrations Work

Integrations connect HeldSway to your platform so that when a customer completes a purchase or rental booking after clicking an affiliate's referral link, the order is automatically sent to HeldSway and a commission record is created in Orders & Commissions.

Without an integration, conversions must be recorded manually via the REST API or HeldSway's JavaScript SDK.

Where to Find Your API Credentials

All integrations — including native platform apps and custom API builds — use credentials generated in Business Settings > API Keys.

Navigate to: Sidebar → Business Settings → API Keys | URL: /settings/api-keys

Related: How to Generate and Manage API Keys | How to Connect HeldSway to RentMy

How to Connect HeldSway to RentMy

Reading time: 4 min by HeldSway Team

HeldSway integrates directly with RentMy, enabling webhook-driven rental order tracking, multi-location commission rules, and recurring rental revenue tracking for all affiliate-driven bookings.

Before You Begin

Make sure you have:

  • An active HeldSway account with at least one affiliate and referral link set up
  • Admin access to your RentMy store dashboard

Step 1 — Generate an API Key in HeldSway

  1. In the left sidebar, click Business Settings, then API Keys.
  2. Click "+ Create Key".
  3. In the Create API Key modal, enter a Name (e.g., "RentMy Integration").
  4. Under Scopes, select the permissions required for RentMy tracking:
    • conversions:write — to record orders as conversions
    • orders:write — to create rental order records
    • clicks:read — to attribute orders to referral clicks
  5. Click "Create Key". Copy the generated API key immediately as it is shown only once.

Step 2 — Configure Webhooks inside RentMy

  1. Log in to your RentMy admin panel.
  2. Navigate to your app integration settings and locate the HeldSway connection panel.
  3. Paste your generated HeldSway API key into the authorization field to connect the systems.
  4. Enable the automated webhook listeners so RentMy can broadcast live rental booking and checkout events to HeldSway instantly whenever a customer completes a transaction.

Step 3 — Verify and Test

  1. Open a private browser window and click one of your affiliate's referral links.
  2. Complete a test rental booking in your RentMy store.
  3. Return to HeldSway and go to Orders & Commissions.
  4. The test order should appear in the ledger within a few minutes, detailing the Order ID, Affiliate, Subtotal, and commission status.

Related: How to Connect HeldSway to WooCommerce | How to Generate and Manage API Keys

How to Connect HeldSway to WooCommerce and WordPress

Reading time: 4 min by HeldSway Team

HeldSway integrates with WooCommerce stores hosted on WordPress, enabling automatic order tracking and commission recording for all affiliate-driven purchases.

Before You Begin

  • Active HeldSway account
  • WordPress site with WooCommerce installed and active
  • Admin access to your WordPress dashboard

Step 1 — Generate an API Key

  1. In HeldSway, go to Business Settings > API Keys.
  2. Click "+ Create Key" and enter a name (e.g., "WooCommerce Integration").
  3. Select the following scopes:
    • conversions:write
    • orders:write
    • clicks:read
    • sdk:init
    • pageviews:write
  4. Click "Create Key" and copy the key immediately.

Step 2 — Add HeldSway Tracking to WordPress

Option A — Via Plugin (Recommended)
Install and activate the HeldSway plugin from the WordPress Plugin Directory. In the plugin settings, paste your API key. The plugin handles the tracking snippet and conversion events automatically.

Option B — Manual Code Integration

  1. Open your WordPress theme's functions.php or use a custom header plugin.
  2. Enqueue the HeldSway tracking script in the site <head> using your API key.
  3. Add a WooCommerce hook on the woocommerce_thankyou action to fire the conversion event with the order ID and total.

Step 3 — Test the Integration

  1. Click an affiliate's referral link in a private browser.
  2. Complete a WooCommerce test order (use WooCommerce's built-in test payment gateway).
  3. Check Orders & Commissions in HeldSway — the order should appear within minutes.

Related: How to Connect HeldSway to RentMy | How to Generate and Manage API Keys

How to Generate and Manage API Keys

Reading time: 4 min by HeldSway Team

Navigation: Sidebar → Business Settings → API Keys | URL: /settings/api-keys

API Keys are the authentication credentials used by any external platform or custom integration to communicate securely with your HeldSway account. This article covers how to create, scope, and manage your API keys.

The API Keys Page

The API Keys page shows a table of all existing keys with these columns:

Column Description
Name The label you gave the key (e.g., "WooCommerce Integration")
API Key The masked key value
Last Used The last time this key was used to make an API call
Created The date the key was generated

Creating a New API Key

  1. Click "+ Create Key" in the top right of the API Keys page.
  2. The Create API Key modal opens.
  3. Enter a Name — use a descriptive name that identifies the integration (e.g., "Production RentMy", "WooCommerce Live").
  4. Select the Scopes (permissions) this key needs. Only grant the scopes required for your integration:
Scope What It Allows
affiliates:read Read affiliate data
affiliates:write Create or update affiliates
conversions:read Read conversion records
conversions:write Submit new conversion events
clicks:read Read click data
clicks:write Submit click events
commissions:read Read commission data
reports:read Read analytics and report data
sdk:init Initialise the HeldSway JavaScript tracking SDK
pageviews:write Record page view events
orders:read Read order records
orders:write Create or update orders
settings:read Read business settings
settings:write Update business settings
connections:read Read integration connections
connections:write Manage integration connections
payouts:read Read payout records
payouts:write Create or update payouts
  1. Click "Create Key".
  2. Copy the key immediately — it is displayed only once and cannot be retrieved again.

Security Best Practices

  • Use a separate API key per integration so you can revoke one without affecting others.
  • Only select the minimum scopes an integration actually needs.
  • Never expose your API key in client-side JavaScript or public code repositories.
  • If a key is compromised, delete it immediately from the API Keys page and generate a new one.

Related: Overview of HeldSway Integrations | How to Connect HeldSway to RentMy