Engagement Editor

Check whether the visual editor will work on a URL

Changed on

Server-side precheck for the tooltip / product-tour editor. Fetches the given URL (SSRF-guarded) and reports blockers (COOP, CSP frame-src, login/cross-origin redirect, invalid URL) so the dashboard can give the user actionable feedback instead of opening a blank editor.

post/engagement/editor/precheck

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/engagement/editor/precheck
  • Auth
    HTTP bearer

Headers

projectstring required

Request body

urlstring required
engagementType'tooltips' | 'producttours'

Reserved. Currently ignored; the precheck result does not depend on the engagement type.

Response

Ok

okboolean required
reachableboolean required
finalUrlstring required

Changes