Dashboards webhook

Dashboards webhooks are triggered when a dashboard report is finished. For more information, see Reporting.

Setting up Dashboards webhooks

To set up a Dashboards webhook:

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

An example webhook payload:

{
    "type": "dashboards.report",
    "timestamp": Date,
    "project": {
        "id": String,
        "name": String
    },
    "organization": {
        "id": String,
        "name": String
    },
    "data": {
        "dashboardId": String,
        "reportSchedule": "day" | "week" | "month",
        "url": String,
        "pdfUrl": String
    }
}