Webhooks

Our webhooks are perfect, if you plan to write your own custom integrations. We currently only support one action "BUG_CREATED", which triggers a request to your defined endpoint. Let us know if you want to see other actions as well.

Method

We send the data of the feedback items through HTTP POST requests. Simply specify your target URL within the webhooks setup dialog and optionally add some header, which will be passed along with the request. The optional headers allow you to secure your HTTP endpoint with some sort of authentication.

Sample data

The following JSON is a sample payload, sent to your webhook.

{
"action": "BUG_CREATED",
"type": "BUG",
"data": {
"priority": "LOW",
"type": "BUG",
"status": "OPEN",
"shareToken": "SAMPLE_TOKEN",
"reportedBy": "[email protected]",
"lexorank": "0|r0002f:",
"bugId": 80,
"generatingScreenshot": false,
"screenshotLive": true,
"generatingReplay": false,
"replayRenderingFailed": false,
"replayLive": false,
"hasWebReplay": true,
"metaData": {
"browserName": "Chrome(92.0.4515.107)",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.107 Safari/537.36",
"browser": "Netscape",
"systemName": "MacOS",
"buildVersionNumber": "",
"releaseVersionNumber": "",
"sessionDuration": 221.667,
"devicePixelRatio": 2,
"screenWidth": 1440,
"screenHeight": 900,
"innerWidth": 1440,
"innerHeight": 735,
"currentUrl": "http://localhost:3000/projects/SAMPLE/integrations",
"language": "de",
"mobile": false
},
"description": "How do Webhooks work?",
"project": "SAMPLE",
"organisation": "5fac06e2a4b97e001782643b",
"createdAt": "2021-07-26T16:36:05.236Z",
"updatedAt": "2021-07-26T16:36:20.999Z",
"__v": 0,
"screenshotDataUrl": "https://bugbattlev2.s3.eu-central-1.amazonaws.com/screenshotdatahtml/60fee475c4d00b0015cdad95.html",
"replayDataUrl": "https://bugbattlev2.s3.eu-central-1.amazonaws.com/replays/60fee475c4d00b0015cdad95.replay",
"replayStartDate": "2021-07-26T16:32:26.380Z",
"screenshotUrl": "https://bugbattlev2.s3.eu-central-1.amazonaws.com/p5feaf3d0490552001775a302/NVTv3Q7dYB05FWbCITbHZeemyu89mM.jpg",
"id": "60fee475c4d00b0015cdad95"
}
}