Alert Webhooks

Owned by Lalit Kawadker (Unlicensed)
Last updated: Feb 02, 2022 by Neha Rankawat (Unlicensed)
266 min read

 

Overview

Alerts Webhooks are event based, thus will be triggered as and when respective events occur. They cannot be scheduled or consolidated.

Prerequisites

Ensure our IPs are whitelisted for both environments:
Sandbox - 13.126.98.143
Production - 13.234.139.9

How to Subscribe

  1. Go through the FT Webhook contracts.

  2. Create an API endpoint with or without permanent authorisation token/key with respect to these contracts.

  3. Raise a support ticket here with the details of your API endpoint and authorisation and the name of FT Alert Webhooks you would like to subscribe to.

  4. Once configured, validate the data flow.

Alert Webhooks

Long stoppage

Long stoppage started

API end point: /alert_long_stoppage_started

Payload Body:

{ "provider": "Freight Tiger", "event": { "name": "alert.long_stoppage_started", "timestamp": 1597376180 }, "trip_id": "1212121", "alert_name": "Long Stoppage", "alert_start_time": 1597376180, "alert_trigger_time": 1597388228, "duration": 200, "alert_status": "In Progress", "escalation": { "level_1_escalated_at": 1597388228, "current_escalation_level": 1 }, "alert_id": "89d914be-237b-4080-8407-016a8a4dd920", "alert_start_location": { "pincode": "151001", "address": "Dabwali Rd, Lal Singh Nagar, Bathinda, Punjab 151001, India", "lon": 74.9352, "lat": 30.1805 }, "distance_from_origin_at_start": 309, "distance_from_destination_at_start": 179 }

Schema:-

{ "type": "object", "properties": { "provider": { "type": "string", "description":"provider name who is triigering event Ex: 'Freight Tiger'" }, "event": { "type": "object", "properties": { "name": { "type": "string", "description":"name of event ex:alert.long_stoppage_started " }, "timestamp": { "type": "integer", "description":"Timestamp when the alert was started epoch in seconds " } } }, "trip_id": { "type": "string"// trip ID same as at time of trip creation }, "alert_name": { "type": "string", "description":"name of alert ex: Long Stoppage " }, "alert_start_time": { "type": "integer" //Timestamp when the alert was started epoch in seconds }, "alert_trigger_time": { "type": "integer" //Timestamp when the alert was triggered epoch in seconds }, "duration": { "type": "integer" // alert duration in minutes }, "alert_status": { "type": "string" // alert status Ex: 'in progress'. }, "escalation": { "type": "object", "properties": { "level_1_escalated_at": { "type": "integer"//Current Alert Escalation Level }, "current_escalation_level": { "type": "integer" //The timestamp at which this level was crossed } } }, "alert_id": { "type": "string" }, "alert_start_location": { "type": "object", "properties": { "pincode": { "type": "string" }, "address": { "type": "string" }, "lon": { "type": "number" }, "lat": { "type": "number" } } }, "distance_from_origin_at_start": { "type": "integer" }, "distance_from_destination_at_start": { "type": "integer" } } }

Long stoppage escalated Level 2

API end point: /alert_long_stoppage_escalated_to_2
Payload Body:

{ "provider": "Freight Tiger", "event": { "name": "alert.long_stoppage_escalated_to_2", "timestamp": 1597389186 }, "trip_id": "12121212", "alert_id": "2d5670e3-85d5-482b-af42-282c8dcbf63e", "alert_name": "Long Stoppage", "alert_status": "In Progress", "alert_start_time": 1597376451, "alert_trigger_time": 1597387953, "duration": 200, "alert_start_location": { "pincode": "431204", "address": " Maharashtra 431204, India", "lon": 75.8001, "lat": 19.631195 }, "distance_from_origin_at_start": 1171, "distance_from_destination_at_start": 1017, "last_known_location": { "pincode": "431204", "address": "Unnamed Road, Maharashtra 431204, India", "lon": 75.79120166666667, "lat": 19.627311111111112 }, "current_distance_from_origin": 1172, "current_distance_from_destination": 1018, "escalation": { "level_1_escalated_at": 1597387953, "level_2_escalated_at": 1597388765, "current_escalation_level": 2 } }

Schema

Long stoppage escalated Level 3

API end point: /alert_long_stoppage_escalated_to_3
Method :- “POST“
request payload:-

schema

Long Stoppage closed

API end point:- /alert_long_stoppage_closed
Method :- “POST“
request payload:-

schema:-

Over Speeding Alert

Over Speeding Started

API end point:- /alert_over_speeding_started
Method :- “POST“
request payload:-

schema

Over Speeding escalated Level 2

API end point:- /alert_over_speeding_escalated_to_2
Method :- “POST“
request payload:-

schema

Over Speeding escalated Level 3

API end point:- /alert_over_speeding_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

Over Speeding closed

API end point:- ​/alert_over_speeding_closed
Method :- “POST“
request payload:-

Schema:-

Night Driving Alert

Night Driving Started

API end point:- /alert_night_driving_started
Method :- “POST“
request payload:-

Schema:-


Night Driving escalated Level 2

API end point:- /alert_night_driving_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

 

Night Driving escalated Level 3

API end point:- /alert_night_driving_escalated_to_3
Method :- “POST“
request payload:-

Schema:-


Night Driving Closed

API end point:- /alert_night_driving_closed
Method :- “POST“
request payload:-

Schema:-

Tracking Interrupted Alert

Tracking Interrupted Started

API end point:- /alert_tracking_interrupted_started
Method :- “POST“
request payload:-

Schema:-


Tracking Interrupted Escalating Level 2

API end point:- /alert_tracking_interrupted_escalated_to_2
Method :- “POST“
request payload:-

Schema:-


Tracking Interrupted Escalating Level 3

API end point:- /alert_tracking_interrupted_escalated_to_3
Method :- “POST“
request payload:-

Schema:-


Tracking Interrupted Closed

API end point:- /alert_tracking_interrupted_closed
Method :- “POST“
request payload:-

Schema:-

Sta Breach Alert

Sta Breach Started

API end point:- /alert_sta_breach_started
Method :- “POST“
request payload:-

Schema:-

Sta Breach Escalating Level 2

API end point:- /alert_sta_breach_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

Sta Breach Escalating Level 3

API end point:- /alert_sta_breach_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

Sta Breach Closed

API end point:- /alert_sta_breach_closed
Method :- “POST“
request payload:-

Schema:-

Trip Validation Failure Alert

Trip Validation Failure Started

API end point:- /alert_trip_validation_failure_started
Method :- “POST“
request payload:-

Schema:-

 

Trip Validation Failure Escalating Level 2

API end point:- /alert_trip_validation_failure_escalated_to_2`
Method :- “POST“
request payload:-

Schema:-

 

Trip Validation Failure Escalating Level 3

API end point:- /alert_trip_validation_failure_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

 

Trip Validation Failure Closed

API end point:- /alert_trip_validation_failure_closed
Method :- “POST“
request payload:-

Schema:-

Trips Common Assets Started

API end point:- /alert_trips_common_assets_started
Method :- “POST“
request payload:-

Schema:-

EWB Expiry Alert

EWB Expiry Started

API end point:- /alert_ewb_expiry_started
Method :- “POST“
request payload:-

Schema:-

 

EWB Expiry Escalating Level 2

API end point:- /alert_ewb_expiry_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

 

EWB Expiry Escalating Level 3

API end point:- /alert_ewb_expiry_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

 

EWB Expiry Closed

API end point:- /alert_ewb_expiry_closed
Method :- “POST“
request payload:-

Schema:-

Waypoint STA Breach Alert

Waypoint STA Breach Started

API end point:- /alert_waypoint_sta_breach_started
Method :- “POST“
request payload:-

Schema:-

 

Waypoint STA Breach Escalating Level 2

API end point:- /alert_waypoint_sta_breach_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

 

Waypoint STA Breach Escalating Level 3

API end point:- /alert_waypoint_sta_breach_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

 

Waypoint STA Breach Closed

API end point:- /alert_waypoint_sta_breach_closed
Method :- “POST“
request payload:-

Schema:-


Detention Origin Alert

Detention Origin Started

API end point:- /alert_detention_at_origin_started
Method :- “POST“
request payload:-

Schema:-

 

Detention Origin Escalating Level 2

API end point:- /alert_detention_at_origin_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

 

Detention Origin Escalating Level 3

API end point:- /alert_detention_at_origin_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

 

Detention Origin Closed

API end point:- /alert_detention_at_origin_closed
Method :- “POST“
request payload:-

Schema:-

Detention Destination Alert

Detention Destination Started

API end point:- /alert_detention_at_destination_started
Method :- “POST“
request payload:-

Schema:-

 

Detention Destination Escalating Level 2

API end point:- /alert_detention_at_destination_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

 

Detention Destination Escalating Level 3

API end point:- ​/alert_detention_at_destination_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

 

Detention Destination Closed

API end point:-/alert_detention_at_destination_closed
Method :- “POST“
request payload:-

Schema:-

Detention Waypoint Alert

Detention Waypoint Started

API end point:- /alert_detention_at_waypoint_started
Method :- “POST“
request payload:-

Schema:-

 

Detention Waypoint Escalating Level 2

API end point:- /alert_detention_at_waypoint_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

 

Detention Waypoint Escalating Level 3

API end point:- /alert_detention_at_waypoint_escalated_to_3
Method :- “POST“
request payload:-

Schema:-

 

Detention Waypoint Closed

API end point:- /alert_detention_at_waypoint_closed
Method :- “POST“
request payload:-

Schema:-

Continuous Driving Alert

Continuous Driving Started

API end point:- /alert_continuous_driving_started
Method :- “POST“
request payload:-

Schema:-


Continuous Driving Escalating Level 2

API end point:- /alert_continuous_driving_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

Continuous Driving Escalating Level 3

API end point:- /alert_continuous_driving_escalated_to_3
Method :- “POST“
request payload:-

Schema:-


Continuous Driving Closed

API end point:- /alert_continuous_driving_closed
Method :- “POST“
request payload:-

Schema:-

Route Deviation Alert Started

Route Deviation Started

API end point:- /alert_route_deviation_started
Method :- “POST“
request payload:-

Schema:-


Route Deviation Escalating Level 2

API end point:- /alert_route_deviation_escalated_to_2
Method :- “POST“
request payload:-

Schema:-


Route Deviation Escalating Level 3

API end point:- /alert_route_deviation_escalated_to_3
Method :- “POST“
request payload:-

Schema:-


Route Deviation Closed

API end point:- /alert_route_deviation_closed
Method :- “POST“
request payload:-

Schema:-

Transit Delay Alert Started

Transit Delay Started

API end point:- /alert_transit_delay_started
Method :- “POST“
request payload:-

Schema:-


Transit Delay Escalating Level 2

API end point:- /alert_transit_delay_escalated_to_2
Method :- “POST“
request payload:-

Schema:-

 


Transit Delay Escalating Level 3

API end point:- /alert_transit_delay_escalated_to_3
Method :- “POST“
request payload:-

Schema:-


Transit Delay Closed

API end point:- /alert_transit_delay_closed
Method :- “POST“
request payload:-

Schema:-

Untracked Alert Started

Untracked Started

API end point:- /alert_untracked_started
Method :- “POST“
request payload:-

Schema:-


Untracked Escalating Level 2

API end point:- /alert_untracked_escalated_to_2
Method :- “POST“
request payload:-

Schema:-


Untracked Escalating Level 3

API end point:- /alert_untracked_escalated_to_3
Method :- “POST“
request payload:-

Schema:-


Untracked Closed

API end point:- /alert_untracked_closed
Method :- “POST“
request payload:-

Schema:-

Responses

Success:- Status code 200

Unauthorized:- Status code 401

Internal server Error: -Status code 500

Post your questions in the comment box to get answers from the experts who watch this page.

For engineering support: visit FT Support