Web App reviews

Create a Web App Review for a deployed or localhost preview URL.

The preview app must be customer-controlled and frameable by Commentary. The Web App Review SDK enables selector comments; screenshot comments can target bounded areas when the SDK is unavailable.

post/api/v1/web-app-reviews

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/web-app-reviews
  • Auth: HTTP bearer

Headers

X-Commentary-Workspace-Idstring

Must match the credential workspace. This header cannot widen grant authority.

X-Correlation-Idstring

Request body

titlestring required
sourceType'deployed_url' | 'localhost' required
previewUrlstring uri required
deliveryMode'auto' | 'embedded' | 'new_tab'
externalMetadataobject

Response

Successful response.

okunknown
reviewIdstring
reviewUrlstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.