Developer API, Webhooks & Connector Builder · OpsIQ

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 reliability.

Key Features

• Scoped Bearer Keys: Generate API keys with least-privilege access to ensure that integrations only have the permissions they need.
• Contract-Generated Actions: Access 1,558 named operations through a single API, with built-in validation and replay-safe writes.
• HMAC Webhooks: Subscribe to events with cryptographic proof, ensuring secure and traceable event delivery.
• OpenAPI and Postman Support: Utilize machine-readable API contracts for easy integration and testing.

Integration Process

1. Get a Key: Sign up and generate a scoped Bearer API key.
2. Discover & Validate: Use the API to read available actions and validate writes with dry-run capabilities.
3. Execute & Subscribe: Perform actions with idempotency keys and subscribe to necessary events.

Event Handling

OpsIQ allows developers to emit canonical events from their platforms, which can be subscribed to by various components like AI brains and automation rules. Events are dispatched in a deterministic order, ensuring that critical actions are prioritized.

Action Contracts

Every operation is governed by a contract that specifies its scope, risk, and confirmation policy. This ensures that the AI can only propose actions that have been registered, maintaining control over what can be executed.

Webhook Security

OpsIQ employs HMAC-SHA256 for signing webhook payloads, allowing developers to verify the authenticity of incoming events. This includes traceable delivery IDs and automatic retries for failed deliveries.

SDKs and Client Generation

Developers can use direct HTTP calls or generate clients in various programming languages, including PHP, Node.js, and Python. The full API is documented in OpenAPI 3.0.3 and available as a Postman collection.

Connector Builder

The Connector Builder allows developers to create governed packages through a six-stage process, ensuring that all necessary validations and checks are performed before release. This includes defining identity, authentication, actions, triggers, and review stages.

Comparison with DIY Integrations

OpsIQ provides a comprehensive solution that includes features like dry-run writes, action-contract registries, and confirmation policies, which are often cumbersome to implement in DIY integrations. The platform's structured approach ensures reliability and security, making it a preferable choice for developers.

FAQs

• Authentication: API calls require a Bearer token, and webhooks include specific headers for verification.
• AI Action Approval: The AI can only propose actions that have been pre-approved in the action registry.
• Webhook Verification: Developers can verify webhooks by recomputing the HMAC signature and comparing it with the provided signature.

For more information, developers can access the documentation and start building integrations with OpsIQ today.