Open Category List

Completing the Integration with Webhook

3 minutesread

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. Learn more about working with the BTS Connectors as part of setting up the integration between the Applause platform and your Bug Tracking System (BTS) here. Learn more about integrating with your BTS here

Prerequisites

  • Response: In order to mark an issue as having been exported successfully, it is required that a response be posted back. Response should include the ID on the issue as created in the receiving system.
  • Make sure that the Applause Platform can communicate with your endpoint. Learn more about required configuration in case your endpoint is behind a firewall here.

Webhook Connector

Once the BTS Integration was enabled for the product, anf Jira was selected as the connector to be set up, You’ll be required to provide the following information:

  • URL:  Set the target URL for the issue export.
    • Note that the suffix “/submit-bug” will be used for the bug export post request (for instance, for the URL “https://myhost.com” the integration will post the export request to “https://myhost.com/submit-bug”).
  • User:  Username of login authenticated by the endpoint.
    • Field is case sensitive. 
    • If your endpoint does not require authentication (not recommended), please use ‘Applause’ as the user.
  • Password: Password of the login authenticated by the endpoint.
    • Field is case sensitive.
    • If your endpoint does not require authentication (not recommended), please keep the password blank.

 

Hints & Tips

  • Authentication:
    • It is highly recommended to require the webhook to authenticate with the endpoint.
    • Note that only basic authentication is supported at this time.

 

Data Exchange

Outgoing Data

When an issue is exported, a POST request will be sent to the URL specified. Here’s an example JSON sent by the integration:

{
     “trigger”:”MANUAL_EXPORT”,
     “data”:{
          “id”:123123,
          “title”:”My Bug”,
          “description”:”My Bug Description”,
          “priority”:”MEDIUM”,
          “productVersion”:”1.2.30″,
          “additionalInfo”:”info info info”,
          “testCycleName”:”My Test Cycle”,
          “productId”:1234,
          “productName”:”My Product”,
          “companyId”:12345,
          “actionPerformed”:”The steps taken”,
          “expectedResult”:”The expected result”,
          “errorMessage”:”Null pointer exception”,
          “lastChangeDate”:”Dec 31, 2020 1:23:45 PM”,
          “bugTrackingIssueId”:””,
          “createDate”:”Dec 31, 2020 1:23:45 PM”,
          “result”:”Actual result”,
          “type”:”BUG”,
          “bugStatus”:”New”,
          “bugFrequency”:”Every Time”,
          “attachments”:[  
                    {  
                         “filename”:”Bug123123_log.txt”,
                         “url”:”https://somehost.com/bug/attachment/Bug123123_log.txt”,
                         “mimeType”:”text/plain”
                    }
          ],          “environments”:[  
                    “Mobile Maker:Apple,Mobile Carrier:T-Mobile United States,Mobile Model:iPhone 5,Mobile Operating System Version:iOS 7.0.4”
          ],
          “reproductions”:[  
                    {  
                         “testerId”:1111111111,
                         “testerName”:”Sally Smith”,
                         “testerRating”:99.1,
                         “comment”:”Some Comment”,
                         “environments”:[  
                              “Apple – Wi-Fi – iOS – iOS 6.x – iPad (Late 2012) Wi-Fi – iOS 6.1.3”
                         ]
                    }
          ],
          “messages”:[
                    {
                         “userName”:”John Jones”
                         “date”:”Dec 31, 2020 1:23:45 PM”,
                         “message”:”this is my message”,
                         “userRole”:”PM”
                    }
          ]
     }
}

 

Available Values

  • Trigger: CREATED / EDITED / MANUAL_EXPORT / STATUS_CHANGED / MESSAGE_ADDED / ATTACHMENT_ADDED / ATTACHMENT_DELETED
  • Priority: LOW / MEDIUM / HIGH / CRITICAL
  • Type: BUG
  • BugStatus: New / Approved / Rejected / Disputed / Discard / Info Requested / Under Review / Pending Approval / Pending Rejection
  • BugFrequency: Every Time / Occasionally / Hardly Ever / Once

Responding

  • Success: The following JSON should be returned in the body of the response with HTTP status: 200:
{  
     “bugId”:”<External Issue ID here>”
}
    • Once the external issue ID has been received, it will be appended to the Applause issue and sent on every subsequent update request.
  • Failure: The following JSON should be returned in the body of the response with HTTP status: 200:
{  
     “message”:”Reason for failure”
}
1
1
757
3 minutesread

Related Knowledge Base Posts