SalesPro Hub API quickstart

Connect your existing business systems to SalesPro Hub and automate your order and inventory workflows. This guide covers everything you need to get up and running.

What You Can Do

SalesPro Hub's integration platform lets you:

• Build an ERP/accounting workflow — A scheduled connector can poll submitted orders, store the ERP reference, and return fulfilment status.
• Push stock levels from your warehouse — Keep inventory in sync by pushing stock counts from your warehouse management or ERP system.
• Synchronise CRM customers — Upsert customers with stable external identities and poll incremental changes without skipping timestamp ties.
• Receive real-time event notifications — Get instant webhook notifications when orders are placed, stock runs low, or statuses change.
• Send automation triggers to Zapier — Deliver retryable order, customer, and completed-visit triggers to validated Zapier catch hooks.

These are integration building blocks and guided recipes. They do not imply a one-click native OAuth connector for Xero, QuickBooks, HubSpot, Sage, or Pastel. See the support matrix before scoping an implementation.

Plan Requirements

Quick Start

1. Create an API Key

1. Go to Settings > API Keys in the SalesPro Hub dashboard.
2. Click Create API Key.
3. Enter a name (e.g., "Sage Integration").
4. Select the permissions you need:
   • orders:read — Read order data
   • orders:write — Update order status and acknowledge orders
   • inventory:read — Read product and stock data
   • inventory:write — Update stock levels
   • customers:read — Read customer/CRM sync data
   • customers:write — Create, update, and deactivate CRM customers
   • zapier:read — Read trigger samples and subscriptions
   • zapier:write — Manage Zapier subscriptions
5. Optionally set an expiration date.
6. Click Create.
7. Copy your API key immediately — it is shown only once.

Your key starts with sk_ followed by 48 random characters. It is stored hashed and cannot be retrieved after the creation screen is closed.

2. Make Your First API Call

Test your key by listing orders:

curl -X GET "https://portal.salesrepsoftware.co.za/api/v1/orders" \
  -H "X-API-Key: sk_your_api_key_here" \
  -H "Accept: application/json"

You should get a JSON response with your orders.

3. Set Up Notifications (Optional)

Go to Settings > Notifications to enable:

• Email alerts when orders are placed
• Low stock email warnings
• Push notifications to mobile devices
• WhatsApp order alerts

4. Set Up Webhooks (Optional)

Go to Settings > Webhooks to receive real-time event notifications:

1. Click Add Endpoint.
2. Enter your endpoint URL and select events to subscribe to.
3. Copy the signing secret for signature verification.

Documentation Index

Base URL

All public integration endpoints use the production base URL:

https://portal.salesrepsoftware.co.za/api/v1/

Private staging environments receive their own base URL.

Need Help?

• Check the Errors & Troubleshooting guide for common issues.
• Contact support through the SalesPro Hub dashboard.