OpsIQ Developer Documentation

Start Here

OpsIQ exposes a stable REST API under /api/v1. Use it when you need to create contacts, open support tickets, read chat history, trigger proactive rules, pull analytics summaries, or manage knowledge-base articles from another system.

curl /api/v1/openapi.php

https://your-opsiq-domain.com/api/v1

Authentication

Create an API key in OpsIQ, assign only the scopes that integration needs, and send it as a bearer token.

Authorization: Bearer opq_your_key_here

curl -H "Authorization: Bearer opq_your_key_here" \
  https://your-opsiq-domain.com/api/v1/tickets

Keys can be rotated at any time. Store them server-side only. Browser widgets should use the widget identity token flow, not public API keys.

Every API v1 response includes a request_id. Keep it with integration logs so OpsIQ support can trace the exact authenticated request, workspace, action, outcome, and latency without storing the caller's raw IP address.

POST /v1.php
{"action":"meta.me"}

meta.me returns the verified key name, scopes, permissions mode, workspace, effective allowed/blocked actions, and recent usage summary for agency and enterprise integrations.

Scopes

Contacts

curl -X POST https://your-opsiq-domain.com/api/v1/contacts \
  -H "Authorization: Bearer opq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ada Lovelace","email":"[email protected]","tags":["trial"]}'

{"tags":["vip","renewal"]}

{"note":"Customer asked for annual billing."}

Tickets

{
  "customer_email":"[email protected]",
  "customer_name":"Example Customer",
  "subject":"Cannot activate account",
  "body":"Activation email never arrived.",
  "priority":"high",
  "department_id":1
}

{"status":"in_progress","priority":"high"}

Chats

Use chat reads for reporting, compliance export, or AI review. For sending live chat messages from a website, use the widget runtime instead of this API.

Analytics

curl -H "Authorization: Bearer opq_your_key_here" \
  "https://your-opsiq-domain.com/api/v1/analytics/summary?preset=30d"

Analytics responses are site-scoped. Visitor/page metrics stay tied to the domain that collected them; shared site groups do not merge per-domain visitor data.

Proactive Events

{
  "event":"checkout.abandoned",
  "email":"[email protected]",
  "cart_total":129.50,
  "currency":"USD"
}

Common events include visitor.high_intent, checkout.abandoned, signup.started, payment.failed, ticket.created, and knowledge.missed_question.

Knowledge Base

{
  "title":"How to reset your password",
  "body":"Open Account Settings, choose Security, then Reset Password.",
  "status":"published"
}

{"status":"published","body":"Updated article body."}

The customer AI can use published knowledge-base content when answering visitors, depending on your AI instruction settings.

Widget And Identity

Install the OpsIQ widget on each website you want to track. Visitor data is collected per domain and stamped to the active site.

<script>
  window.OpsIQSettings = {
    siteKey: 'site_public_key',
    identity: {
      email: '[email protected]',
      name: 'Example Customer',
      external_id: 'cust_123'
    }
  };
</script>
<script src="https://your-opsiq-domain.com/widget.php" async></script>

Use identity when the visitor is logged in. For anonymous visitors, omit identity and OpsIQ will stitch later activity when the visitor identifies themselves.

Webhooks

Webhooks let other tools subscribe to OpsIQ activity. Configure targets in the admin and sign requests with a shared secret.

{
  "event":"ticket.created",
  "id":"evt_123",
  "created_at":"2026-05-25T12:00:00Z",
  "data":{"ticket_id":42,"subject":"Need help"}
}

Connector SDK

Connectors are the production path for platform-specific actions. A connector defines metadata, settings, capability flags, and action specs. OpsIQ calls those actions through the gateway so validation, audit hooks, and platform sync stay consistent.

{
  "slug":"example_platform",
  "name":"Example Platform",
  "version":"1.0.0",
  "manifest_version":1,
  "compatibility":{"opsiq_min":"1.0.0","opsiq_max":"*"},
  "capabilities":["native_api","tickets","customers"],
  "settings":[{"key":"api_key","type":"password","label":"API key"}]
}

{
  "id":"ticket.reply",
  "label":"Reply to ticket",
  "params":{"ticket_id":"string","message":"string"},
  "requires_confirmation":true
}

Email connectors should expose mailbox/piping settings, not store or currency settings. Commerce connectors should expose order/customer/product actions. Support connectors should expose ticket, comment, assignment, and status actions.

Errors And Status Codes

{"success":false,"error":"scope_required:tickets.write","request_id":"req_..."}

Examples

JavaScript fetch

const res = await fetch('https://your-opsiq-domain.com/api/v1/tickets', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer opq_your_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer_email: '[email protected]',
    subject: 'Need help',
    body: 'The checkout page is failing.'
  })
});
const ticket = await res.json();

PHP cURL

$ch = curl_init('https://your-opsiq-domain.com/api/v1/contacts');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer opq_your_key_here',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode(['email' => '[email protected]', 'name' => 'Ada Lovelace']),
]);
$response = json_decode(curl_exec($ch), true);

Python requests

import requests

r = requests.get(
    'https://your-opsiq-domain.com/api/v1/analytics/summary',
    headers={'Authorization': 'Bearer opq_your_key_here'},
    params={'preset': '30d'},
    timeout=20,
)
r.raise_for_status()
print(r.json())