Notes webhook

Notes webhooks are triggered when a member of your organization adds a new note to a session in the Smartlook player.

Adding notes

Setting up Notes webhooks

To set up a Notes webhook:

POST /api/v1/webhooks
BODY: {
  "url": "https://some-url.com",
  "type": "notes",
  "secret": "a-secret"    //optional
}

An example response:

{
    "type": "notes.created"|"notes.updated",
    "timestamp": Date,
    "project": {
        "id": String,
        "name": String
    },
    "organization": {
        "id": String,
        "name": String
    },
    "data": {
        "id": String,
        "author": {
            "name": String,
            "email": String
        },
        "noteType": "session",
        "createdAt": Date,
        "updatedAt": null | Date,    // notes.created | notes.updated
        "text": String,
        "visitor": {
            "id": String
        },
        "session": {
            "id": String,
            "url": String
        },
        "time": Number,
        "commentsCount": Number,
        "parentNote": {               // can contain null
            "id": String,
            "author": {
                "name": String,
                "email": String
            },
            "noteType": "session",
            "createdAt": Date,
            "updatedAt": null | Date,
            "text": String,
            "visitor": {
                "id": String
            },
            "session": {
                "id": String,
                "url": String
            },
            "time": Number,
            "commentsCount": Number
        }
    }
}