First steps - Ekko Webhook

This document provides a comprehensive overview of the device's operational mechanisms, data recording and emission strategies, and back-end integration procedures.

Device Functionality

Core Features and Data Sets

The device utilizes several key features and data sets, including:

Data Recording

The device records various data fields, described in detail in the following resources:

Data recording is governed by configurable policies:

  • Smart Recording Policy: Optimized for GPS data, combining time, distance, and heading changes to minimize data usage while maintaining map accuracy. (Smart recording policy)
  • Event-Based Recording Policy: Triggers recording based on specific events. (Event based recording policy)
  • Periodical Recording Policy: Records data at regular intervals.

Note: Data field activation and recording are configurable. Contact us for specific requirements.

Data Emission Strategy

The device employs a data emission strategy to optimize bandwidth usage:

  • Redundant data suppression: Consecutive identical records are not transmitted. (Emission policy details)
  • Server-side caching: The back-end server caches the latest received values, accessible via interfaces like WebDemo (new records appear in bold).

Webhook Notifications

CloudConnect, our platform, forwards device data to your configured web server via HTTP POST requests (Webhooks).

Notifications are triggered by the following events:

  • presence: Asset connection or disconnection.
  • message: Asset message transmission.
  • track: Asset tracking data transmission.

Key Focus: The track event contains the most relevant data, including timestamps and location.

Integration Steps:

  1. JSON Parsing: Parse the JSON packet received from the Webhook.
  2. track Event Extraction: Identify track events containing recorded data.
  3. Field Decoding: Decode fields from base64 to their respective data types (boolean, integer, string) using the Fields description.

Notification Details:

  • Comprehensive notification documentation: Notification documentation
  • Includes:
    • Track format.
    • JSON schema.
    • Payload examples.
    • Packet aggregation.
    • Retry policy.
    • Security.

Integration Tip: Factor in the device's recording and emission strategies during back-end integration.

Pokes

"Pokes" are events from third-party applications (e.g., PUSH Notification services) that provide specific information. They trigger GraphQL (GQL) calls for data retrieval. See: Pokes Notification.

Ekko Services Overview

https://docs.munic.io/ekko-docs/4_services/

Example Code

The following resources provide example code for back-end integration:

Data Visualization

  • Ekko Fleet Portal: Visualize data via the Ekko Fleet portal.
  • Raw Data Access: Access raw data through the data section.

Server Integration

To configure data delivery to your server, provide your URL via our Helpdesk platform: Helpdesk platform.