API & Integrations

Connect Occuz to your own systems. Whether you want to receive near real-time click data, create campaigns from an external CRM, or track conversions inside a mobile app - the Occuz API gives you the building blocks to do it.

All API features are available from your Occuz dashboard under API & Integrations. Generate your key, grab an SDK, and get started quickly.

Get Your API Key
Occuz API integrations

What the API Offers

Push Webhook

Near Real-Time Click Events

Every time a short link is clicked, Occuz pushes a structured JSON payload to your endpoint in near real time. No polling required. Pipe the data directly into your CRM, data warehouse, or analytics pipeline.

  • Fast delivery on every click
  • Includes UTM parameters, device type, referrer, and location
  • Campaign name, intent label, and campaign ID included
  • Sandbox mode for testing before going live
  • HMAC signature verification for security
  • OAuth support for authenticated endpoints

Campaign Create API

Create Campaigns Programmatically

Issue a single POST request to create a social campaign and short link from any external system. Ideal for automating campaign launches from a CRM, scheduling tool, or marketing platform.

  • Write-only API key - cannot read or modify account data
  • Multiple keys per organisation for team or service isolation
  • Revoke individual keys at any time
  • Supports iOS, Android, and web SDKs
  • No user session required - key-authenticated only
POST /shortener/external-api/create-social
X-Api-Key: <your-api-key>

{
  "type": "social",
  "campaign": {
    "campaign_name": "Summer Sale",
    "campaign_url": "https://yoursite.com/sale"
  }
}

Pixel & Conversion Tracking

Track Every Touchpoint

The Occuz pixel fires after user consent and ties on-site behaviour back to the short link that brought the visitor. Works on any website, single-page app, or native mobile app.

  • Auto-tracks page views, scroll depth, clicks, and video events
  • Captures all utm_* parameters automatically
  • Deep-link interception on iOS, Android, and Huawei
  • Lightweight tag - one script tag or one source file
  • Full GTM support with consent trigger pattern
  • Attribute advertising traffic without a short link via utm_occuz=<campaign_id>

Zapier Integration

Automate Workflows Without Writing Code

Connect Occuz with Zapier to trigger automations whenever campaign links are needed. Route creation into tools your team already uses.

  • Trigger Zaps to create new campaign links
  • Send a smart short link CRM leads and marketing platforms
  • Create internal triggers in Slack, email, or task systems
  • Map Occuz fields to your existing workflow steps
  • Fast setup for non-technical teams
Set Up Zapier

SDKs & Libraries

Every API feature ships with a ready-made SDK. Download a single file, set your key, and start integrating quickly. No package manager or build step required.

Webhook Receiver SDKs

Validate the HMAC signature and start processing events immediately:

Node.js / Express Python / Flask PHP
Campaign Create API SDKs

Make authenticated campaign-creation requests from any platform:

Node.js Python PHP iOS (Swift) Android (Kotlin)
Pixel & Conversion Tracking SDKs

Native session tracking, deep-link interception, and event firing:

iOS (Swift) Android (Kotlin) Huawei (Kotlin) React Native Flutter (Dart)

All SDK files are available for download directly from your Occuz dashboard or via wget.

View SDK Downloads
Quick Example - Webhook Receiver (Node.js)
const express = require('express');
const crypto  = require('crypto');
const app = express();
app.use(express.json());

app.post('/webhook', (req, res) => {
  const sig  = req.headers['x-occuz-signature'];
  const body = JSON.stringify(req.body);
  const hmac = crypto
    .createHmac('sha256', process.env.OCCUZ_SECRET)
    .update(body).digest('hex');

  if (sig !== hmac) {
    return res.status(401).send('Invalid signature');
  }

  const { data } = req.body.records[0].value;
  console.log('Click:', data.campaign_name, data.url);
  res.sendStatus(200);
});

app.listen(3000);
Quick Example - Create Campaign (cURL)
curl -X POST \
  https://api...... \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "type": "social",
    "campaign": {
      "campaign_name": "Summer Sale",
      "campaign_url": "https://yoursite.com/sale",
      "short_url": "summer-sale"
    }
  }'

Ready to integrate?

Log into your Occuz account to generate your first API key, download an SDK, or set up your first webhook.
Questions? Contact us at support@occuz.com.

Open API Dashboard