Product Screenshots and
Help Center Sync API

Automatically capture, compare (diff), and sync product screenshots across any number of Help Centers, or export them to your own cloud buckets and drives, rendered on any device, theme, and language, and kept fresh as your product evolves.

API's at a glance

• Capture Screenshot API Capture screenshots from behind your app's login, in any device, theme, or language.
• Compare Screenshots API Detect visual diffs between two screenshots to catch when collateral goes stale.
• Export Screenshots API Save screenshots straight to your own Cloudflare R2, Amazon S3, OneDrive, or Google Drive.
• Help Center Sync API Import images from and sync fresh screenshots into Zendesk, Intercom, and more.
• Integration API Securely store the storage and Help Center credentials that power it all.

Basic Workflow

1. Capture a Product Screenshot — POST /screenshot

{
  "url": "https://app.acme.com/dashboard",
  "elementSelector": [".main-graph"]
}

2. Compare it against the previous version — POST /screenshot/diff

{
  "baseImage": { "fileObject": "acme/dashboard-baseline.png" },
  "comparisonImage": { "fileObject": "acme/dashboard.png" }
}

3. Write fresh image back to the article — PUT /helpcenter/article/:external_article_id

{
  "integrationId": "d9e45598-d24d-40d8-baf6-33b8765c61b3",
  "screenshots": [
    {
      "name": "dashboard.png",
      "url": "https://lbscreenshots.s3.us-east-1.amazonaws.com/acme/dashboard.png",
      "hash": "e3b0c44298fc1c149afbf4c8996fb924",
      "metadata": { "OriginalDocumentID": "9CI9", "ImageDescription": "Dashboard" }
    }
  ]
}

See the full Screenshot API reference or start with Getting started.