Webhooks documentation

Basics

The Webhooks make a POST request to the endpoints you specify. The Content-Type header will be application/json.

To set up your webhook endpoints, you'll need to go to the setup page of your application, and find the Notifications > Webhooks section.

New Feedback

id
int, the ID of the feedback thread
email
string, the email address of the user who submitted the feedback
url
string, the permalink of the feedback thread
user_agent
string, the formatted user agent string
parsed_user_agent
object, has 3 keys: platform, browser, and version. Will have empty values if it wasn't submitted from the Javascript SDK
message
string, the message the user sent
sentiment
string, the sentiment of the message. Can have values of positive, neutral, or negative
application
object, has 2 keys: id, and name
properties
array, array of object, with each object containing: type, name, and value
created_at
string, the UTC time string of when the feedback was submitted

Example output

{
    "event": "new-feedback",
    "data": {
        "id": 467,
        "email": "jimbo@example.com",
        "url": "https:\/\/doorbell.io\/applications\/15\/feedback\/467",
        "member": {
            "id": 168,
            "name": "Jimbo",
            "email": "jimbo@example.com"
        },
        "user_agent": "  on  ",
        "parsed_user_agent": {
            "platform": null,
            "browser": "CCBot",
            "version": "2.0"
        },
        "message": "Here is the feedback that the user sent",
        "sentiment": "",
        "application": {
            "id": 15,
            "name": "Your Application Name"
        },
        "properties": [
            {
                "type": "boolean",
                "name": "logged-in",
                "value": true
            },
            {
                "type": "integer",
                "name": "user-id",
                "value": 877029
            }
        ],
        "created_at": "2017-04-24 19:53:44"
    }
}

To see an example of the webhooks before you integrate, you can use a service like http://requestb.in/

New Reply

id
int, the ID of the reply
email
string, the email address of the user who replied
url
string, the permalink of the feedback thread
message
string, the message the user sent
feedback
object, has 2 keys: id, and created_at
application
object, has 2 keys: id, and name
created_at
string, the UTC time string of when the feedback was submitted

Example reply from member

{
    "event": "new-reply",
    "data": {
        "id": 892,
        "email": "reply@example.com",
        "reply_from_agent": false,
        "url": "https:\/\/doorbell.io\/applications\/15\/feedback\/467",
        "message": "This is the reply message",
        "feedback": {
            "id": 467,
            "member": {
                "id": 168,
                "name": "Jimbo",
                "email": "jimbo@example.com"
            },
            "created_at": "2017-04-24 19:53:44"
        },
        "application": {
            "id": 15,
            "name": "Your Application Name"
        },
        "created_at": "2017-04-24 20:08:44"
    }
}

Example reply from agent

{
    "event": "new-reply",
    "data": {
        "id": 892,
        "email": "reply@example.com",
        "reply_from_agent": true,
        "url": "https:\/\/doorbell.io\/applications\/15\/feedback\/467",
        "message": "This is the reply message",
        "feedback": {
            "id": 467,
            "member": {
                "id": 168,
                "name": "Jimbo",
                "email": "jimbo@example.com"
            },
            "created_at": "2017-04-24 19:53:44"
        },
        "application": {
            "id": 15,
            "name": "Your Application Name"
        },
        "created_at": "2017-04-24 20:08:44",
        "agent": {
            "id": 708,
            "name": "Gilbert",
            "email": "gilbert@example.org"
        }
    }
}

To see an example of the webhooks before you integrate, you can use a service like http://requestb.in/