Webhooks

📘

Webhooks are available on the Premium Plan. Compare Plans | Upgrade Now

Userback supports pushing New Feedback to a custom webhook URL that you provide via our Integrations page. When a webhook is set up, we will push the Feedback data to the URL provided.

Webhook Setup

To create a new Webhook destination, navigate to Integrations and set up your Webhook connection by clicking Connect. All you need to provide is the URL of your webhook server.

Webhook Format

Our webhook format has the following structure in the body of a POST request in JSON format.

  • id: - the unique feedback ID
  • feedback_type: the type of Feedback submitted (Bug Report, Feature Request, or General Feedback)
  • date: date & time when feedback was submitted in format ISO-8601
  • project: project name where feedback was received
  • url: direct URL to feedback (opens feedback viewer)
  • page: source URL, where feedback was submitted from
  • email: reporter email address
  • name: reporter full name
  • location: reporter location (IP Geolocation: Town, Country, Zip/Postcode)
  • priority: priority of feedback
  • category:
  • rating:
  • vote:
  • dpi:
  • colour_dept:
  • title:
  • description:
  • browser:
  • window_size:
  • screen_resolution:
  • video:
  • screenshot: list of all screenshots included with feedback submission
    • url: direct URL to the screenshot image
    • window_size: Window size when screenshot was taken, as multiple screenshots can be added
  • attachment:
  • comments: - List of all comments included with Feedback,
    • comment
    • attachment
    • position_x
    • position_y
    • screenshot_number which screenshot this comment applies to
  • custom_data:
  • user_data:
    • field_name
    • field_value
  • console_logs:
  • html_content:

Webhook Example

{
  "id": 2007850,
  "feedback_type": "Bug Report",
  "date": "2022-09-06T06:37:19+10:00",
  "project": "Pied Piper",
  "url": "https://app.userback.io/viewer/36351/71811/2007850MSNv8n6f/",
  "page": "https://curo.im/",
  "email": "[email protected]",
  "name": "Custom Person",
  "location": "Te Puke New Zealand 3119",
  "priority": "Urgent",
  "category": "",
  "rating": "",
  "vote": 0,
  "dpi": 1,
  "colour_depth": "24-bit",
  "title": "This is an example title",
  "description": "This is an example of the comment section",
  "browser": "Chrome 104.0.0.0 (Windows)",
  "window_size": "2337 x 1279",
  "screen_resolution": "3440 x 1440",
  "video": "",
  "screenshot": [
    {
      "url": "https://static.userback.io/15363/project/71811/feedback/2007850/screenshot/iIETed_1405670.png",
      "window_size": "2337 x 1279"
    }
  ],
  "attachment": "https://static.userback.io/15363/project/71811/feedback/2007850/attachment/IR330_2022.pdf",
  "comments": [],
  "custom_data": {
    "account_id": "555",
    "page": "999"
  },
  "user_data": [],
  "console_logs": "JQMIGRATE: Migrate is installed, version 3.3.2 \r\n",
  "html_content": "<p>Custom Person ([email protected]) <b>created</b> a new <a href=\"https://app.userback.io/viewer/36351/71811/2007850MSNv8n6f/\">feedback</a> on <a href=\"https://curo.im/\">https://curo.im/</a></p>\n<blockquote>This is an example of the comment section</blockquote>\n<br>\n<div><img src=\"https://static.userback.io/15363/project/71811/feedback/2007850/screenshot/iIETed_1405670.png\" width=\"520\" style=\"display:block;max-width:100%;border:1px solid #DDDDDD;box-shadow:0 2px 10px rgba(0,0,0,0.1);\"></div>\n<p></p>\n<p>\n    <b>Project:</b> Pied Piper<br>\n    <b>Feedback ID:</b> 2007850<br>\n    <b>Rating:</b> <br>\n    <b>Browser:</b> Chrome 104.0.0.0 (Windows)<br>\n    <b>Attachment:</b> <a href=\"https://static.userback.io/15363/project/71811/feedback/2007850/attachment/IR330_2022.pdf\">IR330_2022.pdf</a><br>\n    <b>account_id:</b> 555<br><b>page:</b> 999<br>\n</p>\n<p>\n    View Details: <a href=\"https://app.userback.io/viewer/36351/71811/2007850MSNv8n6f/\">https://app.userback.io/viewer/36351/71811/2007850MSNv8n6f/</a>\n</p>"
}asd

Did this page help you?