Webhooks | Online Help | Zoho BugTracker

Webhooks

Webhooks facilitate automated HTTP notifications to third party applications from Zoho BugTracker. Using Webhooks, you can configure your own HTTP URLs and associate them to specific business rules in order to automate the entire notification process related to bugs. To know more about Webhooks, please refer to WebHooks.org.

Configure Webhooks

  1. Navigate to  > Bug Tracker > Webhooks.
  2. Click Add Webhook.
  3. In Webhooks page, specify all the necessary parameters.
  4. Click Save.

List of fields in Webhook configuration 

Field Name
 Description
 Data type
 Constraint
Name

Specify the Webhook name.

Text

100 characters
URL to notify

Specify the REST API URL of the third-party application.

 URL
 1000 characters
Method

Select the type of API method - POST or GET. By default, the POST method is selected.

 Radio button
 -
Append bug parameters
  • Append parameters in two ways - either using the standard format or user defined format (xml, json, etc.,).
  • Specify the parameter name. And specify the corresponding parameter value chosen from the bug fields.
  • These parameters are significant in triggering the webhook to the third party.
 Text
 3000 characters
Append custom parameters
  • Specify the parameter name and the corresponding value for the webhook.
  • This key / value pair is mainly used to send the Auth tokens, api key etc.,
 Text
 3000 characters
Preview URL

Preview the complete webhook URL to notify the third-party application.

 Read-only
 Read-only

Associate Webhooks to a Business Rule

  1. In Business Rules, navigate to Rule details -> Criteria -> Actions.
  2. In Actions, click Call Webhooks.
  3. Click  to create a new Webhook or click  to call an existing Webhook for the business rule.

  4. Click Save Rule.

Test Webhook Integration

  1. Add test data in Zoho BugTracker according to your business rule criteria.
  2. In your application check for the update / data received from Zoho BugTracker via a webhook notification.
  3. If there is an error or data mismatch, modify your webhook settings in Zoho BugTracker.
  4. Continue testing until you get the desired results from Zoho BugTracker to your Application.
Webhooks supports both Bug related Parameters (Bug title, Status, Assignee etc.,) and Custom Parameters.

Known Limitations

  • Only 10 Bug related parameters and 5 Custom parameters are allowed per Webhook.
  • One bug related parameter in user defined format(xml, json..) is allowed.
    • Sample bug related parameter in user defined format: <bug-data><title>${Bug.BugTitle}</title><key>${Bug.BugKey}</key></Bug-data>
  • Webhook is triggered only through a business rule i.e. when a business rule is executed, the associated webhook is called.
  • Only one webhook is associated to a business Rule whereas multiple business rules are mapped to the same webhook.
  • Only 1000 webhook calls are allowed per day.
  • A failed webhook execution is not retried.
  • Webhook is deactivated when the webhook call fails continuously for 10 attempts.
  • No mail notification is sent if the webhooks call threshold is reached for the day or if the webhook is disabled due to continuous failure.
  • Webhook failures are audited and the Webhook Failures page displays only the last 100 failures.