Webhook

2 minute read

We assume you are already familiar with our API authentication; if not please watch before:
CargoStart API a Sneak Peek introduction
StarTracking Authentication and Authorization

In short, when one of the desired events are triggered (such as Routemap replan, Milestone Update, etc.), StarTracking will send an HTTP POST payload to a sender webhook’s sender URL.

All you need is to develop - using your preferred language - a brand new simple WebAPI Server or to implement a Notification endpoint in your WebAPI Server.

Insert a Webhook

Inform StarTracking WebHook service the URL address and the endpoint where to notify all the notification payload.

POST /ffw/startracking/routemap/webhook HTTP/1.1
Host: api.startracking.aero
Accept: application/json, text/plain, */*
Content-Type: application/json;charset=UTF-8
Authorization: Bearer {{BEARER TOKEN}}
Content-Length: 177

{
    "Event": "FWB,LAT,RCS,DEP,ARR,RCF,NFD,DLV,RMP,CAN",
    "Url": "https://www.mycoolsite.com/WebHookST7",
    "Enable": false,
    "Type": "text",
    "AWB": "125"
}

If everything is 200 OK, StarTracking API will return an answer with all the summary information:

{
    "Id": 35,
    "ForwarderIdentifier": "SMECCIEMB",
    "Event": "FWB,LAT,RCS,DEP,ARR,RCF,NFD,DLV,RMP,CAN",
    "Url": "https://www.mycoolsite.com/WebHookST",
    "Token": null,
    "Enabled": false,
    "Type": "json",
    "Psk": null,
    "AWB": null
}

In this example, we created a disabled rule to notify all the milestones events to the https://www.mycoolsite.com/WebHookST website.

Keep in mind:
Type property accepts json, xml or text
Token property (optional) can be only a valid JWT token; please refer to https://jwt.io for more information
Psk property (optional) in case your web API supports preshared key.

Search Webhook

The API endpoint to return a paged list of all saved webhook configurations

GET /ffw/startracking/routemap/webhook HTTP/1.1
Host: api.startracking.aero
Accept-Encoding: gzip, deflate, br
Accept: application/json
Authorization: Bearer {{BEARER TOKEN}}