Use your existing service interface
Read alerts and drive cases through a documented REST API.
Keep your service's front end and connect the security work behind it. The Platform API lets supported systems read alerts, drive cases, run playbooks or push events. Signed webhooks carry case changes outward, while your own agents can call published tools over MCP under execution policy.
The caller authenticates with its own key. Scopes govern access to module operations.
Grant the module scopes the service needs.
Sample requests and responses. No token or request secret is shown.
Case events cover creation, updates and closure.
# Sample Python; client configured securely
page = client.alerts.list(status="open")
for alert in page["items"]:
print(alert["id"])Permission to connect is not permission to execute.
The illustrative mdr-ticketing key has alerts read and cases write access. It has no execute scope.
The service reads alerts and creates a case through permitted API operations. Response codes are illustrative.
A case.closed event reaches the service with an HMAC SHA-256 signature. Verify the signature in the receiving service.
Use an SDK for REST calls or let your own agents call published tools over MCP. Execution policy applies to tool calls.
Use the Platform API to connect existing systems to Imperum. Scoped access lets your integration read or change the work it needs, while case webhooks can notify your service of changes.
The Platform API provides a REST interface with interactive documentation. API keys or OAuth2 client credentials authenticate the caller, with scopes for module operations such as read, write, execute and approve. Outbound webhooks announce case creation, updates and closure with HMAC SHA-256 signatures. Python and TypeScript SDKs support integrations, and a separate Reporting API issues tokens for BI tools. Your team can use those surfaces to connect customer workflows to its own service interface.
Your front end can work with Imperum records while the integration has an explicit scope of access.
Illustrative integration and scopes. No credentials or live request data are shown.
Read alerts and drive cases through a documented REST API.
Use signed webhooks to bring case lifecycle events into your service.
Decide which operations the service will call, then configure its authentication and scopes. Review the result with a sample workflow before using it for customer work.
Open interactive documentation under Settings, Integrations and review the operations.
Configure authentication and the module scopes needed by the integration.
Configure case events and verify the HMAC SHA-256 signature in the receiving service.
Publish the tools your own agent may call and review their execution policies.
Permission to connect is not permission to execute. Licensed capabilities, scopes, permissions and applicable approval policies still apply.
REST integrations and MCP clients serve different callers. Use connectors for external tool access and the gateway for published tool calls; bring an engineer into the integration work when needed.
API access follows enabled modules and granted scopes.
Call the capabilities enabled in the issued license.
Operational module access still follows license and permissions.
Use the API to work with security records and webhooks to receive their changes. Your service can retain its own interface while Imperum supplies the licensed capabilities behind the workflow.
Build the connection through REST and the supported SDKs.
Subscribe to case creation, update and closure events.
Review scopes for REST callers and execution policy for MCP tools.
Pick an alert read or case operation your integration needs.
Configure authentication without including secrets in application source.
Test the permitted call and signature verification for a case webhook.
The Platform API exposes REST operations to read alerts, drive cases, run playbooks or push events. API keys or OAuth2 client credentials authenticate callers, and module scopes determine access. Python and TypeScript SDKs support integration work. Confirm the licensed modules and permissions required by the workflow.
Outbound case webhooks cover case creation, updates and closure and are signed with HMAC SHA-256. Configure the receiving service and verify the signature before processing an event. The event list described here covers cases.
Have any other questions? Talk to our team
Bring your API workflow to Imperum and review its scopes, licensed capabilities and execution controls.