Skip to main content

External System Integration for Incidents & Tasks

External System Integration for Incidents & Tasks

BzCtrl. provides a feature that allows external systems to create Incidents and Tasks directly through REST API communication. This enables operational systems to register issues or actions directly within their own workflows while ensuring follow-up and tracking take place in BzCtrl.

The main value of this feature is that it allows Incidents and Tasks to be created directly from specific screens or processes within an external operational system, without requiring users to manually enter data into BzCtrl.

Integration Flow

The integration process consists of the following steps:

  1. Authentication

    • The external system authenticates using a dedicated API Username and Password.

    • Authentication is performed through a separate API request.

    • A successful authentication returns the token or authorization required for further communication.

  2. Create Incident or Task

    • The external system sends a PUT request using a predefined message structure.

    • The request contains the information required to create the Incident or Task in BzCtrl.

  3. Response from BzCtrl.

    • BzCtrl. returns a response message confirming successful creation.

    • The response includes the direct URL to the Details Page of the created Incident or Task.

    • This URL can be stored in the external system for direct access and traceability.



Example Integration Flow

Step 1 – Authentication Request

POST /api/authenticate  {   "username": "api_user",   "password": "********" }

Example Authentication Response

{
  "token": "eyJhbGciOiJIUzI1NiIs..."
}

Step 2 – Create Incident or Task

Example PUT Request

PUT /api/task

{
  "type": "Incident",
  "title": "Incorrect customs status identified",
  "description": "Mismatch detected during goods receipt",
  "workspace": "Inbound Control",
  "priority": "High"
}

Step 3 – Response from BzCtrl.

Example Response

{
  "status": "Success",
  "reference": "INC-2026-00125",
  "url": "https://app.bzctrl.com/incidents/INC-2026-00125"
}

The returned URL provides direct access to the Details Page of the created Incident or Task within BzCtrl.

Typical Use Cases

  • Registering operational incidents directly from ERP or WMS systems

  • Creating follow-up Tasks from external compliance applications

  • Linking operational activities with compliance monitoring in BzCtrl.

  • Providing users direct access from the external system to the corresponding item in BzCtrl.

[Insert screenshots of API requests, responses, and Details Page here]

Back to top