Webhooks

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

Userback provides webhook that allows you to receive HTTP push notifications whenever data is created or updated. This allows you to build integrations on top of Userback.

Webhook Setup

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

How does a webhook work?

A Webhook push is simply a HTTP POST request, sent to the URL of your choosing. The push is automatically triggered by Userback when data updates.

Webhook Payload

The webhook HTTP payload will include information both in its HTTP headers and its 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 the action that took place: `create`, `update`, `remove`.
`type`	The type of entity that was targeted by the action.
`data`	The event data.
`timestamp`	The date and time (in unix timestamp) that the action took place.
`url`	URL of the entity.

Webhook Events:

Feedback Create

{
  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

{
  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

{
  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

{
  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

{
  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

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

Feedback Comment Create

{
  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/"
}

Feedback Comment Status Change

{
  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/"
}

Feedback Comment Edit

{
  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/"
}

Feedback Comment Delete

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