Webhooks

Overview

Webhooks enable your application to receive real-time HTTP push notifications whenever data is created or updated in Userback. They act as a bridge, instantly connecting Userback to your external systems, applications, and workflows.

Prerequisites

Before you begin, ensure the following:

• Userback Workspace: A workspace is needed to collect and manage feedback.
• Access Token: Retrieve your token via the Code Icon in your workspace.
• Plan Requirements: Webhooks require the Scale Plan or higher.
• Webhook Receiver: Set up a server endpoint to handle incoming webhook requests.

Why Use Webhooks?

Webhooks allow you to connect Userback with your external systems, enabling real-time updates and automation:

• Automate Workflows: Trigger actions like creating tasks in project management tools.
• Real-Time Notifications: Get immediate updates on feedback and comments.
• Custom Integration: Build tailored solutions by leveraging event data.

How to Set Up Webhooks

1. Navigate to Integrations:
   Go to the Connect page in your project.

2. Connect a Webhook:
   Select "Connect" under Webhooks and add your webhook URL.

3. Test the Connection:
   Use the built-in "Test" feature to validate the webhook setup.

Webhook Events

Webhooks can notify you of the following events:

Feedback Events

• New Feedback: Triggered when new feedback is added.
• Feedback Assigned: Updates when feedback is assigned to a user.
• Status Changed: Notifies when feedback status is updated (e.g., Open → Resolved).
• Priority Changed: Triggered when feedback priority changes.
• Feedback Voted: Updates when feedback votes are modified.
• Feedback Deleted: Triggered when feedback is removed.

Comment Events

• New Comment: Triggered when a new comment is added to feedback.
• Comment Updated: Notifies when an existing comment is edited.
• Status Changed: Updates when a comment status changes (e.g., Public → Private).
• Comment Deleted: Triggered when a comment is removed.

Webhook Payload Structure

Each webhook sends data via HTTP headers and a JSON payload.

Headers

Content-Type: application/json; charset=utf-8  
User-Agent: Userback-Webhook  

Payload Example

{
  "action": "create",
  "type": "feedback",
  "data": {
    "id"                : 2007850,
    "feedback_type"     : "bug",
    "project"           : "Pied Piper",
    "email"             : "[email protected]",
    "name"              : "John Doe",
    "priority"          : "Urgent",
    "category"          : "UI,Frontend",
    "assignee"          : "John Doe",
    "rating"            : 5,
    "vote"              : 0,
    "dpi"               : "2.0",
    "colour_depth"      : "24-bit",
    "title"             : "Feedback Title",
    "description"       : "...",
    "browser"           : "Chrome 138.0.7204",
    "window_size"       : "1920 x 1080",
    "screen_resolution" : "1920 x 1080",
    "video"             : "https://example.com/video.mp4",
    "screenshot"        : "https://example.com/screenshot.png",
    "attachment"        : "https://example.com/attachment.zip",
    "comments"          : {...}, // screenshot pin comments
    "custom_data"       : {...},
    "user_data"         : {...},
    "console_logs"      : {...},
    "html_content"      : "...",
    "share_url"         : "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Payload Fields

🛟 Support

Need help? Here’s how to get assistance:

1. Log in to your Userback workspace.
2. Click the Help Center icon in the top-right corner.
3. Select Contact us to start a chat with our support team.