Snapshot webhooks

Webhooks can be added to a site in order to get Snapshot data (metrics, links to screenshots & videos, etc) out of Calibre.

Setup

  • Navigate to the site in Calibre, then Settings → Integrations → Add Webhook.
  • Paste in the destination URL (Data will be delivered as application/json via HTTP POST.
  • Check the "Snapshot" event checkbox.
  • Click "Save notification".

Once a snapshot has completed (all pages and all devices have been successfully tested), data will be delivered to the configured destination.

We recommend that you use a third party webhook test service, or enable verbose logging in order to verify the webhooks are delivered in the format as expected.

Example JSON output

See example command output { "id": 1485, "organisation_id": "your-organisation-id", "site_id": "apple", "primary_region_id": "us-east-1", "ref": null, "client": "web", "status": "completed", "html_url": "https://calibreapp.com/your-organisation-id/apple/snapshots/1485", "url": "https://calibreapp.com/api/sites/apple/snapshots/1485.json", "created_at": "2018-07-16T23:33:17.970Z", "pages": [ { "id": "iphone-x", "name": "iPhone X", "status": "completed", "endpoint": "https://www.apple.com/iphone-x/", "canonical": false, "profile": "iPhone 6, 3G connection", "metrics": [ { "name": "speed_index", "value": 14097 }, { "name": "visually_complete", "value": 21317 }, { "name": "visually_complete_85", "value": 21217 }, { "name": "lighthouse-seo-score", "value": 75 }, { "name": "lighthouse-best-practices-score", "value": 75 }, { "name": "lighthouse-accessibility-score", "value": 87 }, { "name": "lighthouse-performance-score", "value": 10 }, { "name": "lighthouse-pwa-score", "value": 45 }, { "name": "js-parse-compile", "value": 6888 }, { "name": "time-to-first-byte", "value": 128 }, { "name": "first-contentful-paint", "value": 4433 }, { "name": "first-meaningful-paint", "value": 11649 }, { "name": "firstRender", "value": 3724 }, { "name": "dom-size", "value": 2110 }, { "name": "estimated-input-latency", "value": 859 }, { "name": "consistently-interactive", "value": 22607 }, { "name": "first-interactive", "value": 21248 }, { "name": "json_body_size_in_bytes", "value": 2901 }, { "name": "json_size_in_bytes", "value": 1747 }, { "name": "image_body_size_in_bytes", "value": 863765 }, { "name": "image_size_in_bytes", "value": 863790 }, { "name": "font_body_size_in_bytes", "value": 402256 }, { "name": "font_size_in_bytes", "value": 404248 }, { "name": "js_body_size_in_bytes", "value": 1815834 }, { "name": "js_size_in_bytes", "value": 425500 }, { "name": "css_body_size_in_bytes", "value": 1329225 }, { "name": "css_size_in_bytes", "value": 93630 }, { "name": "html_body_size_in_bytes", "value": 425563 }, { "name": "html_size_in_bytes", "value": 42739 }, { "name": "page_wait_timing", "value": 1740 }, { "name": "page_size_in_bytes", "value": 2530039 }, { "name": "page_body_size_in_bytes", "value": 5537450 }, { "name": "asset_count", "value": 59 }, { "name": "onload", "value": 22592 }, { "name": "oncontentload", "value": 12595 } ], "budget_alerts": null, "artifacts": { "filmstrip": { "thumbs": [ "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1682063.892.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1682532.696.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1685799.232.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1686499.204.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1686899.188.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1687299.172.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1688782.446.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1690182.39.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1691349.01.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1692448.966.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1693715.582.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1703281.866.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1703365.196.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/1703381.862.jpg" ], "video": "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/screencast.mp4", "gif": "https://calibre-screenshots-prod.s3.amazonaws.com/05efb55f-0d2b-4c25-afd4-06dd7038fada/video-timeline/screencast.gif" }, "har": "https://calibre-screenshots-prod.s3.amazonaws.com/5e7ebd8f932d99e2a017fd1e16551221/https___www_apple_com_iphone_x_/har/20180716233507265.json?X-Amz-Expires=3600&X-Amz-Date=20180716T233521Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAITFRYATLYAH7W3VQ/20180716/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=be3e0818f2b8c24114d2813faf83b11e3a6d6b8084c84fb44ecde27104215045" } }, { "id": "iphone-6", "name": "iPhone 6", "status": "completed", "endpoint": "https://www.apple.com/iphone-6/", "canonical": false, "profile": "iPhone 6, 3G connection", "metrics": [ { "name": "speed_index", "value": 8517 }, { "name": "visually_complete", "value": 11477 }, { "name": "visually_complete_85", "value": 10760 }, { "name": "lighthouse-seo-score", "value": 68 }, { "name": "lighthouse-best-practices-score", "value": 68 }, { "name": "lighthouse-accessibility-score", "value": 93 }, { "name": "lighthouse-performance-score", "value": 26 }, { "name": "lighthouse-pwa-score", "value": 36 }, { "name": "js-parse-compile", "value": 1501 }, { "name": "time-to-first-byte", "value": 108 }, { "name": "first-contentful-paint", "value": 3470 }, { "name": "first-meaningful-paint", "value": 8449 }, { "name": "firstRender", "value": 2398 }, { "name": "dom-size", "value": 727 }, { "name": "estimated-input-latency", "value": 17 }, { "name": "consistently-interactive", "value": 24364 }, { "name": "first-interactive", "value": 11378 }, { "name": "json_body_size_in_bytes", "value": 1716 }, { "name": "json_size_in_bytes", "value": 1011 }, { "name": "image_body_size_in_bytes", "value": 1968564 }, { "name": "image_size_in_bytes", "value": 1973146 }, { "name": "font_body_size_in_bytes", "value": 346672 }, { "name": "font_size_in_bytes", "value": 348381 }, { "name": "js_body_size_in_bytes", "value": 1077849 }, { "name": "js_size_in_bytes", "value": 271680 }, { "name": "css_body_size_in_bytes", "value": 720939 }, { "name": "css_size_in_bytes", "value": 62227 }, { "name": "html_body_size_in_bytes", "value": 51148 }, { "name": "html_size_in_bytes", "value": 9958 }, { "name": "page_wait_timing", "value": 198 }, { "name": "page_size_in_bytes", "value": 2666403 }, { "name": "page_body_size_in_bytes", "value": 4166888 }, { "name": "asset_count", "value": 73 }, { "name": "onload", "value": 28932 }, { "name": "oncontentload", "value": 7034 } ], "budget_alerts": null, "artifacts": { "filmstrip": { "thumbs": [ "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1683338.5.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1683999.304.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1685749.234.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1686815.858.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1686882.522.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1688649.118.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1689749.074.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1691798.992.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1693432.26.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1693732.248.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1694015.57.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1694032.236.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1694098.9.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1694315.558.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1694498.884.jpg", "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/1694815.538.jpg" ], "video": "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/screencast.mp4", "gif": "https://calibre-screenshots-prod.s3.amazonaws.com/67ec59cf-0121-4ab7-ab38-e2f4459c40da/video-timeline/screencast.gif" }, "har": "https://calibre-screenshots-prod.s3.amazonaws.com/f477b5ec59c5a357f1f7d756b23c4645/https___www_apple_com_iphone_6_/har/20180716233446500.json?X-Amz-Expires=3600&X-Amz-Date=20180716T233521Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAITFRYATLYAH7W3VQ/20180716/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=86e1fe079e3ce90c81bf81a62369c71c03c31640412cd22dce92c1996f4247b7" } } ] }