Browse by category 5 subcategories
50 articles · In this section
Developer API, Webhooks & Connector Builder — OpsIQ
OpsIQ offers a robust platform for building governed integrations through its Developer API, Webhooks, and Connector Builder. This enables developers to create AI-operable applications with a focus on security and…
What are OpsIQ connector capability types and profiles?
OpsIQ Connector Capability Types and Profiles The integration control plane currently describes 52 capability types and 7 starting profiles. A profile represents a common platform shape, such as: Standard API Commerce…
Does the OpsIQ API support idempotency?
Yes, the developer model includes idempotent replay protection for writes. This feature includes a documented 24-hour idempotency window for supported operations. Clients should reuse the same key when retrying the same…
How does the OpsIQ Connector Builder work?
The Connector Builder uses six guided stages: Identity, Authentication, Connection Test, Actions, Triggers, and Review. Builders can start from OpenAPI, Postman, cURL, or a selected profile. Authentication options…
How many operations are available through the OpsIQ General API?
The current developer and integrations pages describe 1,558 named General API operations governed by 62 least-privilege scopes. The operation registry ensures that API behavior, action documentation, scopes, and…
Can OpsIQ connect to a custom backend?
Yes, OpsIQ can connect to a custom backend. A custom backend can utilize the General API, webhooks, Connector Builder, or explicit AI Action endpoints. The architecture should expose only the identity, context, events…
Can OpsIQ integrate with Shopify or WooCommerce?
Yes, OpsIQ can integrate with Shopify and WooCommerce. OpsIQ's commerce and Sales Bridge materials describe the integration patterns for Shopify and WooCommerce, as well as other commerce platforms. Connected commerce…
Does OpsIQ work with WHMCS?
Yes, OpsIQ works with WHMCS. Hosting and WHMCS form a first-class solution pattern. A WHMCS connector can provide authenticated customer, service, invoice, domain, order, and support context, and expose approved…
How many canonical outbound webhook events does OpsIQ have?
Canonical Outbound Webhook Events in OpsIQ The Webhooks & Actions page describes a total of 30 canonical outbound events, along with the capability for wildcard subscriptions. Endpoints can subscribe to the events they…
How does OpsIQ protect remote HTTP actions from SSRF?
Remote actions utilize declared endpoints and include protections against server-side request forgery (SSRF). These protections come with various authentication options, including Bearer, API key, Basic, and HMAC. To…
Does OpsIQ support REST and GraphQL integrations?
Yes, OpsIQ supports integrations through standard REST or GraphQL-style APIs. The connector model focuses on the capabilities that the external system exposes. Authentication methods include: Bearer API key Basic OAuth…
Can I group multiple Remote Sites together?
Yes, Remote Sites can carry group identity, which helps multi-brand or agency workspaces organize related sites while preserving site-level scope. Groups improve navigation and rollups, but they do not automatically…
OpsIQ Documentation & Developer Docs — OpsIQ
OpsIQ Documentation & Developer Docs Overview OpsIQ provides comprehensive documentation for users to effectively set up, operate, and extend its platform. This includes guidance on various functionalities such as AI…
Are all OpsIQ integrations equally available?
No, not all OpsIQ integrations are equally available. Some connectors are bundled as General Availability (GA), while others are bundled as Preview. Additionally, marketplace packages may have their own readiness…
Can authenticated users move between an OpsIQ portal and a remote domain?
OpsIQ describes a signed cross-origin identity token that is based on the site key, secret, role/context information, and a limited lifetime. This mechanism allows a remote site to establish a trusted identity without…
Can I use webhooks to connect OpsIQ to another website or application?
Using Webhooks to Connect OpsIQ Yes, you can use webhooks to connect OpsIQ to another website or application. Signed webhooks serve as a primary event-driven integration method, while the General API and AI Actions…
Can Remote Sites report sales conversions to OpsIQ?
Yes, Remote Sites support sales-conversion bridge patterns, allowing purchases and other outcomes to be attributed to the correct site and journey. Templates are provided for environments such as WooCommerce and custom…
How are OpsIQ outbound webhooks signed?
OpsIQ signs outbound webhook payloads using HMAC-SHA256 over the raw request body. It also includes delivery metadata such as the timestamp and event. Receivers should follow these steps: Calculate the signature from…
What SDK and API reference formats does OpsIQ provide?
OpsIQ provides an OpenAPI 3.0.3 description, Postman resources, and helper patterns for PHP, Node.js, and Python. This allows teams to integrate with their preferred technology stack instead of relying on a single…
How do I add another website to OpsIQ?
To add another website to OpsIQ, follow these steps: Create a Remote Site with the following configurations: Label Domain Group Tracking configuration Install the generated snippet that contains the unique site key. The…
Portal Studio administrator and developer guide — OpsIQ
Overview OpsIQ Portal Studio allows you to build, preview, govern, publish, and extend an enterprise customer portal. This guide provides essential information for both administrators and developers to effectively…
What is the OpsIQ webhook retry schedule?
After an initial failed webhook delivery, the documented retry sequence is as follows: 1 minute 5 minutes 30 minutes 2 hours 12 hours After the sixth total attempt, the delivery is marked as failed. The delivery history…
How does API rate limiting work in OpsIQ?
OpsIQ applies API rate limits per key and returns rate-limit information in the response headers. When a limit is exceeded, clients receive an HTTP 429 status code along with guidance on when to retry through the…
Can I build my own integration for OpsIQ?
Yes, you can build your own integration for OpsIQ using the Connector Builder. This tool allows you to define identity, authentication, tests, actions, triggers, and review metadata. You can start your integration from…
How do I authenticate to the OpsIQ General API?
Authenticating to the OpsIQ General API OpsIQ's General API utilizes scoped Bearer API keys. It is important that these keys are assigned only the least-privilege scopes necessary for their function. Additionally, they…
Integrations, API & Connector Builder — OpsIQ
OpsIQ offers a robust platform for integrating various systems through governed packages, APIs, and signed webhooks. Users can also build, publish, and sell connectors via the OpsIQ Marketplace. The integration process…
Does the OpsIQ API support dry-run requests?
Yes, the OpsIQ API supports dry-run requests. Supported operations can utilize the dry_run behavior, allowing integrators to validate intent and parameters without committing the write. This feature is particularly…
How does OpsIQ prevent one Remote Site from seeing another site's data?
How OpsIQ Prevents Data Visibility Between Remote Sites Remote-site records are assigned a specific site scope, and OpsIQ implements row-level scoping to ensure that data is accessible only within the authorized site or…
How many integrations and connector capabilities does OpsIQ have?
Integration and Connector Capabilities of OpsIQ The current integration control plane reports the following: 23 bundled packages 21 marketplace entries 52 capability types 7 starting profiles 1,558 General API actions…
What does GA, Preview, or contract-ready mean for an OpsIQ connector?
Understanding GA, Preview, and Contract-Ready for OpsIQ Connectors GA stands for General Availability, which means that a bundled package has passed the platform's general-availability release governance. Preview…
Can each Remote Site have different branding?
Yes, OpsIQ supports per-site branding and configuration while keeping sites under one workspace. This feature is beneficial for groups with several brands, regional sites, or agencies. Please note that full white-label…
Can a Marketplace security scan reject my connector?
Yes, the Marketplace performs static security checks on submitted connector packages. Significant findings can result in the package being held, rejected, or quarantined for further review. It is important to correct…
Can I temporarily disable an API token without deleting it?
Yes, API Tokens support disabling and later re-enabling a token. You can disable a token when an integration should temporarily stop using it. Please remember that the connected integration will fail authentication…
What are Remote Sites in OpsIQ?
Remote Sites allow one workspace to operate across multiple websites. Each site is assigned a unique site_key and a drop-in script. These sites report a heartbeat and can have their own branding or chat configuration…
How do I create an OpsIQ customer API token?
To create an OpsIQ customer API token, follow these steps: Open the API Tokens section. Create a token with a descriptive name. Select the appropriate available permissions. After the token is created, copy the secret…
Why can't I see my API token secret again?
The token secret is intentionally shown only at the time of creation. The account stores what it needs to verify future token use, rather than a reusable clear-text copy for later display. If you lose the secret, you…
Can I use an OpsIQ API token instead of my account password for an integration?
Yes, you can use an OpsIQ API token instead of your account password for supported customer API operations. This method is preferable to providing an integration with your interactive account password because the token…
Signed Webhooks & API Actions for Automation — OpsIQ
OpsIQ offers a robust solution for automating workflows through signed webhooks and API actions. With features like HMAC-signed webhooks, verified inbound events, and governed backend actions, OpsIQ ensures secure and…
What are customer API tokens in OpsIQ?
Customer API tokens allow you to authorize supported customer-scoped integrations without sharing your account password. These tokens can carry limited permissions for supported account, license, billing, or support…
Does uploading a connector ZIP publish it immediately?
No, uploading a connector ZIP does not publish it immediately. When an author uploads a connector, it creates a submission that undergoes automated checks and review. The publication of the connector depends on the…
What information can I see about an API token?
The API Tokens page provides various details about each token, including: Token Name Public Identifier Granted Permissions Current Status Usage Information (e.g., when it was last used) Note that the secret itself is…
Who can download OpsIQ Self-Hosted software?
Downloads are available to eligible Self-Hosted customers when downloads are enabled and the related subscription or trial is active. Cloud-only customers typically use their provisioned workspace instead of downloading…
What can appear in Self-Hosted Downloads?
The account can publish the main Self-Hosted package and, depending on your entitlement and current release, additional integration or developer packages. The exact packages, versions, and availability are controlled by…
How do I install the Self-Hosted edition?
How to Install the Self-Hosted Edition To install the Self-Hosted edition, download the current package available for your active Self-Hosted entitlement. Follow the installation or quick-start guidance provided with…
Why don't I see the Downloads menu?
The menu is entitlement-aware and may be hidden if your account does not have any eligible Self-Hosted products or if Self-Hosted downloads are disabled. If you believe you have an active Self-Hosted entitlement but…
What happens when I delete an API token?
Deleting a token permanently removes that customer token from active use. Any integration still configured with it will stop authenticating and must be updated with a new token if access is still required. If you want a…
What does 'Not bound' mean on a Self-Hosted licence?
The term 'Not bound' indicates that the license currently has no domain binding recorded in the account display. The behavior of domain binding can vary depending on the product and installation flow. Please follow the…
Can I see my Self-Hosted download history?
Yes, you can view your download history where the download-history functionality is available. The Download History feature displays when a package was downloaded, along with package and version information, file…
Why is a Self-Hosted package shown as unavailable?
A package may be shown as unavailable for two main reasons: it has not been published for your entitlement, or its release-integrity requirements have not been satisfied. The account intentionally avoids serving a…
Do Cloud customers need a licence key?
Normal OpsIQ Cloud access is based on the customer-owned workspace and its entitlement, rather than on installing a Self-Hosted licence key. Licence keys in the customer account are primarily relevant to eligible…