Skip to content

Business Events

A Business Event is the core abstraction that connects an external API operation to a BizMetry Telemetry Frame — defining when to capture telemetry, where to intercept it, which fields to extract, and how to map them to the Frame components your Template defines.

If the Telemetry Template is the blueprint of what you want to observe, a Business Event is the wiring that makes observation happen at runtime.

🧭 Concept Overview

When an external system calls one or more API operations on your platform, BizMetry needs to know:

  • Which call to intercept — the API Collection and specific operations.
  • Which frame type to populate — the target Telemetry Frame in the Template.
  • Which fields from the request/response payload to extract — and how to map them to frame components.

A Business Event encapsulates all of this configuration in a single, versioned, lifecycle-managed entity.

flowchart LR
    API["API Operation\n(REST, Kafka, Webhook)"]
    BizEvent["Business Event\n(interception + mapping)"]
    Frame["Telemetry Frame\n(frame type + components)"]
    Agent["BizMetry Agent\n(capture + transmit)"]
    Platform["BizMetry Platform\n(analytics + KPIs)"]

    API -->|"intercepted by"| BizEvent
    BizEvent -->|"populates"| Frame
    Frame -->|"captured by"| Agent
    Agent -->|"transmits to"| Platform

🧩 Business Event Components

Each Business Event is composed of:

Component Description
Identity Name, description, and interception mode (INBOUND, OUTBOUND, INBOUND_OUTBOUND).
Target Frame The Frame Type from the Template that this event will populate when fired.
Event Source The transport mechanism — REST API, Kafka Topic, MQTT Queue, or Webhook.
Selected Operations The specific API operations (endpoints + HTTP methods) to intercept.
Field Mappings The mapping between source fields (request/response payload) and target frame components.
BMEL Expressions Optional expressions written in the BizMetry Expression Language for computed or multi-field mappings.

🔄 Lifecycle

Business Events are versioned entities. Each version goes through a managed lifecycle:

stateDiagram-v2
    [*] --> DRAFT : Created
    DRAFT --> PUBLISHED : Publish
    DRAFT --> [*] : Delete
    PUBLISHED --> DEPRECATED : Template bumped\n(new version forked)
    PUBLISHED --> RETIRED : Manual retire
    DEPRECATED --> PUBLISHED : Reinstate
    DEPRECATED --> RETIRED : Manual retire
    RETIRED --> [*]

See Lifecycle & States and Versioning for full details.

🗂️ Accessing Business Events

  1. Open a Profile from the Home Screen.
  2. From the Profile's tab bar, click on Business Events.

Screenshot pending

Capture required: Profile detail view with the "Business Events" tab highlighted in the tab bar.

The Business Events tab opens, showing all events and their current versions.

📋 Business Events Tab Overview

The tab displays a list of all Business Events defined for this Profile:

Column Description
Event Name Identifier for this business event.
Source API Collection and transport type.
Target Frame The Frame Type this event maps to.
Version Current active version number.
Status Lifecycle state of the current version: DRAFT, PUBLISHED, DEPRECATED, RETIRED.
Actions Create new version, edit, manage lifecycle transitions.

Screenshot pending

Capture required: Business Events tab showing a list of events with version pills and status badges.

🔗 In This Section