Webhooks

Webhooks enable you 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. This guide offers step-by-step instructions on configuring webhooks and outlines the structure and content of webhook payloads.

🔐 Premium Plan or higher required - To explore subscription options, visit our plans and pricing.

Why Webhooks Matter

Userback webhooks open up a world of possibilities for your feedback management. By tapping into real-time events within Userback, you can automate processes, keep stakeholders informed, and gain deeper insights from customer feedback.

Setting Up Webhooks

Configuring webhooks in Userback is straightforward. Here's how you can set up a webhook connection:

Navigate to the Integrations section in your desired Userback project.
Click on "Connect" to create a new webhook connection.
Provide the URL of your webhook server where Userback should send the notifications.

Understanding Webhook Payload

The Webhook payload consists of information in both the HTTP headers and the request body.

HTTP headers:

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

The payload body has the following structure:

Key	Description
`action`	The type of action that took place: `create`, `update`, or `remove`.
`type`	The type of entity that was targeted by the action.
`data`	The event data.
`timestamp`	The date and time (in Unix timestamp) when the action took place.
`url`	The URL of the entity.

Webhook Events:

Here are some use-cases and examples of events that can be received through the Userback webhook:

Feedback Create

This event is triggered when a new feedback item is created.

{
  "action": "create",
  "type": "feedback",
  "data": {
    "id": 2007850,
    "feedback_type": "Bug Report",
    "date": "2022-09-06T06:37:19+10:00",
    "project": "Pied Piper",
    "url": "https://app.userback.io/viewer/123456/98765/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/123456/project/98765/feedback/2007850/screenshot/iIETed_1405670.png",
        "window_size": "2337 x 1279"
      }
    ],
    "attachment": "",
    "comments": [],
    "custom_data": {
      "account_id": "123456",
      "page": "999"
    },
    "user_data": [],
    "console_logs": "JQMIGRATE: Migrate is installed, version 3.3.2"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f

Feedback Assign

This event is triggered when a feedback item is assigned to a user.

2. **Feedback Assign**

This event is triggered when a feedback item is assigned to a user.

```json
{
  "action": "update",
  "type": "feedback_assignee",
  "data": {
    "feedback_id": 2073017,
    "from": "Unassigned",
    "to": "Lee Le"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Feedback Status Change

This event is triggered when the status of a feedback item changes.

{
  "action": "update",
  "type": "feedback_status",
  "data": {
    "feedback_id": 2073017,
    "from": "Open",
    "to": "Resolved"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Feedback Priority Change

This event is triggered when the priority of a feedback item changes.

{
  "action": "update",
  "type": "feedback_priority",
  "data": {
    "feedback_id": 2073017,
    "from": "Neutral",
    "to": "Urgent"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Feedback Vote

This event is triggered when the vote count of a feedback item changes.

{
  "action": "update",
  "type": "feedback_vote",
  "data": {
    "feedback_id": 1869641,
    "from": 25,
    "to": 26,
    "name": "Someone",
    "email": "[email protected]"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Feedback Delete

This event is triggered when a feedback item is deleted.

{
  "action": "remove",
  "type": "feedback",
  "data": {
    "feedback_id": 2073017
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Comment Create

This event is triggered when a new comment is added to a feedback item.

{
  "action": "create",
  "type": "feedback_comment",
  "data": {
    "feedback_id": 2073015,
    "comment_id": 1455410,
    "reply_to": 0,
    "name": "Someone",
    "email": "[email protected]",
    "comment": "The bug has been fixed :)",
    "attachment": "",
    "is_public": 1
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Comment Status Change

This event is triggered when the status of a comment on a feedback item changes.

{
  "action": "update",
  "type": "feedback_comment",
  "data": {
    "feedback_id": 1269241,
    "comment_id": 867699,
    "comment": "this is the comment body",
    "from": "Resolved",
    "to": "Open"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Comment Edit

This event is triggered when a comment on a feedback item is edited.

{
  "action": "update",
  "type": "feedback_comment",
  "data": {
    "feedback_id": 1269241,
    "comment_id": 867699,
    "from": "this is the comment body",
    "to": "this is the new comment body"
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}

Comment Delete

This event is triggered when a comment on a feedback item is deleted.

{
  "action": "remove",
  "type": "feedback_comment",
  "data": {
    "feedback_id": 1269241,
    "comment_id": 867699
  },
  "timestamp": 1667263011,
  "url": "https://app.userback.io/viewer/123456/98765/2007850MSNv8n6f/"
}