Monday, September 9, 2013

Increased Payload

WebhooksDevelopers are slowly starting to make use of ITRP's Webhooks functionality. A webhook is basically a listener that listens for transactions. Webhooks are useful, for example, when you want to build a little mobile app that tells a service owner when the implementation of a change for one of his/her services has started. In that case, you can set up a webhook that listens for updates to change records. And when this webhooks detects the update of a change, it will notify the server to which the the app's users are connected. This is just an example. The possibilities are endless.

So, every time a webhook gets triggered it sends out some information. This information was essentially limited to the ID of the record that triggered the webhook. This ID would then be used to make an API callback to ITRP to obtain the current field values of this record. These transactions are extremely fast, but overall this was not terribly efficient. That's because in most cases the API information would tell the server that no action was necessary. In the context of our example app, the server would generally be told that the change had not yet reached the status "Implementation".

To make it possible for external programs to decide whether a callback to ITRP is needed, we recently extended the information that webhooks send out. This information now includes a whole new payload section. This section contains the parameters that are most often used to decide whether or not an API callback is needed. These parameters include the Source, Status, Team and Member field values.

In the Webhooks section of the ITRP developer documentation you will find all the information on these additional parameters.