What Are FT Webhooks?

FT webhooks notify other systems that want an update whenever certain data has changed. Webhooks are predefined instructions, so there's no need for programmers to regularly make requests to external systems for data. Instead, the webhook is set up once and the other system sends data whenever it's triggered. Many refer to webhooks as reverse APIs because developers need to design an API endpoint for a webhook to call that’s able to parse the data received, which is the opposite of programming requests to an external API. The API endpoint - or URL - is considered a “listener” that waits for the FT application to send a request, and transforms the data received however necessary.

Read more about Webhooks:

How to Consume a Web hook?

1. Decide on what even you want a callback on. Example: You might want an update for the changing location of a trip.

2. Find the relevant web hook. Refer https://freighttiger.atlassian.net/wiki/spaces/FCS/pages/51249326

3. Go to detailed documentation.

   1. Check the event it gets triggered on. Its written in the web hook description

   2. Check Schema of the request body of the web hook

   3. Check the example payload value. You may be interested in part of the request data.

4. Implement an API with same request data structure

   1. This is normally a very lean API which might be just mapping FT fields with fields in your system. Or you might want to pass data received from the call back to multiple applications.

   2. FT Web hooks have large payloads to cater to diverse needs of our customers. There could be some fields that you do not need to get back from FT. You can skip those.

   3. Do not change the names of the JSON attributes

5. Raise a request to Freight Tiger to configure the web hook

   1. Go to https://freighttiger.atlassian.net/servicedesk/customer/portals

   2. Submit a request to configure the web hook

6. Once FT tech support team configures your end-point in the requested webhook, your API will start getting the calls