Open Category List

How To Integrate With Webhooks

3 minutesread

For basic integration information, please see:  ‘Integrating With Third-Party Bug Tracking Systems’

Using WebHook integration, you can establish communication between Applause and your site.  Outgoing webhooks allow you to export bugs reported within the Applause platform to an  external URL.

Setting Connection Credentials:

bts_integrationsetup_webhook

 

URL:  The target URL for the bug export. Note that  “/submit-bug’” will be used for the bug export post request (e.g URL: https://myhost.com, will post the export request to: https://myhost.com/submit-bug)

User:  Case sensitive login credentials.
Password:  Case sensitive login credentials.
 NOTE:   In case your endpoint doesn’t require authentication, please use ‘Applause’ as the user and leave the password blank.
Setting Triggers Config
After creating the WebHook connection, you will be able to set the triggers config.

You can set bugs to automatically be exported after: bug creation, bug edit, adding/removing bug attachments, change bug status, and adding a bug message.

Outgoing Data

When an issue is exported, a POST request will be sent to the URL specified. Thedata is defined as follows:

{

“trigger”:”MANUAL_EXPORT”,

“data”:{

"id":1224497,
   "title":"My bug title",
   "description":"The Bug Description",
   "priority":"MEDIUM",
   "productVersion":"21-41",
   "additionalInfo":"info info info",
   "testCycleName":"My TestCycle",
   "productId":1234,
   "productName":"My Product",
   "companyId":12345,
   "actionPerformed":"The steps",
   "expectedResult":"expecting something",
   "errorMessage":"Null pointer exception",
   "lastChangeDate":"Dec 30, 2014 2:31:58 PM",
   "bugTrackingIssueId":"",
   "createDate":"Dec 25, 2014 8:47:58 AM",
   "result":"welcome to reality",
   "type":"BUG",
   "bugStatus":"New",
   "bugFrequency":"Every Time",
   "attachments":[  
      {  
         "filename":"Bug1224497_wordlist.txt",
         "url":"https://somehost.com/bug/attachment/Bug1224497_wordlist.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":46369,
         "testerName":"Sally Smith",
         "testerRating":99.53290557861328,
         "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":"April 24, 2015 12:25:22 PM",
     "message":"this is my message",
     "userRole":"PM"
    },
    {
     "userName":"John Jones"
     "date":"April 24, 2015 12:25:22 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
In order to mark an issue as having been pushed successfully, it is required that a response be posted back. The following JSON should be returned in the body of the response with HTTP status: 200:
{  
   "bugId":"ABC-123"
}

Once Applause has received an external issue Id it will be appended to the Applause ticket and sent on every subsequent push updates.

In case of export failure, it is required that a response be posted back. The following JSON should be returned in the body of the response with HTTP status: 200:

{  
   "message":"Reason for failure"
}

Static IP Address and/or URL Note

If required, IT administrators should configure their firewalls to whitelist the following  platform IP range:

  • 184.73.216.29
  • 23.21.127.192/28 (CIDR notation) OR 23.21.127.192 – 23.21.127.206 (range notation)

NOTE:   We do not support two step authentication at this time, only basic authentication.

1
0
71
3 minutesread

Related Knowledge Base Posts