Webhooks

Webhooks allow our system to automatically push asset, log and point data to your system when they change. For example, when one of our monitoring devices closes out a flight log, our system can automatically send that log to your system. The webhook will be sent within 60 seconds of an update to an asset, log or point. If multiple objects have changed since the last post, multiple entries will be included in the single webhook post.

Configuration

To enable webhooks, you will need to set the endpoint where you would like the data to be sent. This should be in the form of a web URL. This can be set on the group settings page in our application. If you would like to disable the webhook, simply erase the web URL can click save.

POST Data format

The webhook will post a JSON object to your endpoint. That object is the equivalent to calling the assetList API command with the following arguments:

asset_types=all
asset_updated_after=timestamp of the oldest entry in the last webhook post
log_types=all
log_updated_after=timestamp of the oldest entry in the last webhook post
log_limit_per_asset=999
point_types=first,last
                

Expected response

{
    "cmd": "webhookAssetList",
    "group_uuid": "00000000-0000-0000-0000-000000000000",
    "server_timestamp": 1580498821000,
    "asset_count": 4,
    "error": ""
}
                        

Sample code

This sample code is written in PHP and demonstrates how your endpoint should reply to a webhook post.

<?php

// Initialize our response
$response = new stdClass();
$response->cmd = 'unknown';
$response->group_uuid = '00000000-0000-0000-0000-000000000000';
$response->server_timestamp = time();
$response->asset_count = 0;
$response->error = '';

// Process the data
try {

    // Collect the post data
    $post_raw = file_get_contents("php://input");
    if (!$post_raw) throw new Exception('No data was received');

    // Decode the JSON into a PHP object
    $post_decoded = json_decode($post_raw);
    if (!$post_decoded) throw new Exception('Invalid json data received');

    // Collect the group UUID
    if (!isset($post_decoded->group->uuid)) throw new Exception('No group uuid was received');
    $response->group_uuid = $post_decoded->group->uuid;

    // Collect the command
    if (!isset($post_decoded->cmd)) throw new Exception('No cmd was received');
    $response->cmd = $post_decoded->cmd;

    // Verify the command
    if ($response->cmd != 'webhookAssetList') throw new Exception('Invalid command was received');

    // Did we receive any assets
    if (!isset($post_decoded->assets) OR !is_array($post_decoded->assets)) throw new Exception('No assets were received');

    // Step through the aircraft
    foreach ($post_decoded->assets AS $asset {
        $response->asset_count++;

        // -- YOUR CUSTOM CODE HERE TO PROCESS THE ASSET --

    }

    // Catch our errors
    } catch (Exception $e) {
        $response->error = $e->getMessage();
        http_response_code(400);
    }

    // Return a JSON object response
    $response_json = json_encode($response);
    header('Content-type: application/json');
    echo $response_json;
?>