Overview

This section provides a technical overview of how the Tezzela API is structured and how its key components interact.

Tezzela operates through a RESTful API that follows a simple and predictable data model. Each dashboard consists of a set of widgets, and each widget displays a specific type of data (text, chart, list, etc.). All communication is done via JSON payloads and authenticated using access tokens.

Architecture

  • Dashboards are the top-level entities that group related widgets. Each dashboard is identified by a unique id, and linked to a specific to value (typically an email address or user TCode that will view it).

  • Widgets are modular components within dashboards. Each widget is identified by an id and has a specific type which determines how the data is visualized.

  • Endpoints are organized by function:

    • /dashboards: Create, update, and retrieve dashboards.

    • /notify: Send push-style notifications to users associated with dashboards.

Request Format

All API requests should be sent using GET , POST , PUT or DELETE (depending on the operation), and must include a valid API key in the headers:

Common Workflow

  1. Authenticate and generate an API key.

  2. Define a dashboard with its widgets via the /dashboards endpoint.

  3. Send updates to the widgets whenever data changes.

  4. Optionally, notify users via the /notify endpoint.

Each dashboard and widget is fully configurable, allowing you to adapt the visualization to your use case. For detailed widget structures, see the Widgets section

Start by creating a token and sending your first dashboard — it's that simple.

Last updated