Completing the Integration with Webhook


Webhook is one of the BTS connector types. Using Webhook integration you can export issues reported within the Applause platform to an endpoint reachable as an external URL. This is one of the options offered by the Applause platform to integrate with an unsupported Bug Tracking System.

This article provides information about specific setups required when configuring the BTS Connector with Webhooks.

Prerequisites
Webhook Connector

Once the BTS Integration was added, Webhook was selected as the connector type and products were assigned, you will be required to provide the following information:

Notes and Tips

 

Data Exchange

Webhook sends exported bug details to defined URL as an HTTP request with JSON formatted body. Often it is used for bug tracking system integrations which are not officially supported in the Applause platform. You need to provide a “client” that is able to receive this request at a given URL for further processing and/or import. Export is triggered based on connector configuration for any of the five predefined events:

Webhook connector allows only for customisation of the Subject and Description fields, no other custom mappings can be made.

Note: The Webhook connector type should not be confused with “Jira webhook” or "ADO webhook", which are part of the 2-way Jira or ADO integration and are created in a customer’s Jira/ADO to send back issue updates to the Applause platform.

Bug Export Request

JSON format is used with 6 top level elements:

 

Trigger
Name Type Value (one of)
trigger String

CREATED

EDITED

MANUAL_EXPORT

STATUS_CHANGED

MESSAGE_ADDED

ATTACHMENT_ADDED

ATTACHMENT_DELETED

 

Fields

List of bug fields with one of three formats:

1. Name and value (String or Number) e.g.

{
  "name": "buildName",
  "value": "1.1"
}

2. Name, value (Number) and options e.g.

{
  "name": "severity",
  "value": 3,
  "options": [
    {
      "value": 1,
      "label": "Low"
    },
    {
      "value": 2,
      "label": "Medium"
    },
    {
      "value": 3,
      "label": "High"
    },
    {
      "value": 4,
      "label": "Critical"
    }
  ]
},

3. Name and list of values (Strings), only environments e.g.

{
  "name": "environments",
  "values": [
    "macOS - OS X 10.10.5",
    "French (France) - Windows - 2003 - Chrome",
    "French (France) - Windows - 2003 - Internet Explorer 10"
  ]
},

List of all fields:

Name Type Options Comments
id Number no  
title String no  
description String no Line breaks using “\n”
productId Number no  
productName String no  
buildName String no  
testCycleId Number no  
testCycleName String no  
component String no  
status Number yes  
severity Number yes aka. priority
type Number yes  
frequency Number yes  
additionalInfo String no  
actionPerformed String no  
expectedResult String no  
actualResult String no  
createDate String no Date and time (ISO-8601)
url String no URL to bug in Customer App
source Number yes  
verification Number yes  
environments List of strings no

Only basic form. All environment values are concatenated with “ - “. For more data see top-level environments.
errorCode String no  
errorMessage String no  

 

Environments

Detailed list of all bug environments with values e.g.

"environments": [
  {
    "environment": {
      "Operating System": "macOS",
      "Operating System Version": "OS X 10.10.5"
    }
  },
  {
    "environment": {
      "Language": "French (France)",
      "Operating System": "Windows",
      "Operating System Version": "2003",
      "Web Browser": "Chrome"
    }
  },
  {
    "environment": {
      "Language": "French (France)",
      "Operating System": "Windows",
      "Operating System Version": "2003",
      "Web Browser": "Internet Explorer 10"
    }
  }
],

 

Attachments

Detailed list of all bug attachments e.g.

"attachments": [
  {
    "name": "Bug60005_150.png",
    "type": "image/png",
    "url": "https://test-zubin.s3.amazonaws.com/1/1/3/60005/bugAttachment/Bug60005_150.png?AWSAccessKeyId=AKIAIHFLYREWQSTX2NTQ&Expires=1988447586&Signature=ealP%2BOwR%2BugV5sVv7NztHS7D%2BvA%3D"
  }
],

 

Reproductions

List of all bug reproductions with attachments and simplified environments only

"reproductions": [
  {
    "testerId": 50,
    "comment": "This is comment for reproduction",
    "createDate": "2022-12-15T09:55:57.000+0000",
    "attachments": [
      {
      "name": "600_400.png",
      "type": "image/png",
      "url": "https://test-zubin.s3.amazonaws.com/60005/bugReproduction/1/600_400.png?AWSAccessKeyId=AKIAIHFLYREWQSTX2NTQ&Expires=1988447586&Signature=3DRCcs6ON%2BchhShBYRZJXroNuDU%3D"
      }
    ],
    "environments": [
      "Linux - Ubuntu - Polish - Firefox",
      "Linux - Ubuntu - English - Chrome"
    ]
  }
],

 

Custom Fields

Name and value (String) format e.g.

"customFields": [
  {
    "name": "Size",
    "value": "Medium"
  }
]

 

Response

In order for bug export to be marked as “successful” in the Applause platform, response should:

{
  "bugId":"some-id-123"
}