Webhooks


Webhooks allow you to integrate other tools that you use with Tuskr. For example, if you use a home-grown time tracking system, then your webhook code can log time to it whenever a user adds a result with time in Tuskr.

When a test run result is added, modified or deleted, Tuskr will perform an HTTP POST on your webhook URLs with the result data.

Returning Issue IDs from external systems

A webhook that posts when a test run result is created can return a JSON object like this { "issueIds" : [id1, id2, ...] } that contains IDs of issues created in an external issue tracking system. The corresponding test run result will be updated with these IDs.

Managing Webhooks

To create, edit or delete webhooks, you need the administrator privilege. Go to Main MenuAdministrationWebhooks to manage them.

Viewing Posted Data

You can view the JSON data posted to your webhooks. Go to Main MenuAdministrationWebhooks and click on a webhook's name. You will see a list of all attempts. Click on the icon in the row of an attempt to view the posted data.

Retrying Failed Attempts

It could happen that the site hosting your webhook code was down for maintenance and Tuskr's call to your webhook failed. In such a scenario, if the option was selected for the webhook, then all administrators will receive an email notification.

You can retry these failed attempts. Go to Main MenuAdministrationWebhooks and click on the webhook's name. You will see a list of all attempts and their status i.e. whether they succeed or failed. Click on the icon in the row of a failed attempt to repost data to your webhook.

Continuously Misbehaving Webhooks

If Tuskr detects that a webhook is repeatedly failing, the webhook could be marked as inactive. After fixing your webhook code or configuration, you can reactivate it.