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

POST /api/v1/web-app-reviews

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.

Access

Use a credential with commentary.comments.write.

Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.

Parameters

Name	Location	Type	Required	Description
`X-Commentary-Workspace-Id`	header	string	No	Must match the credential workspace. This header cannot widen grant authority.
`X-Correlation-Id`	header	string	No

Request body

Required. Supported content types: application/json.

Field	Type	Required	Description
`collaboration`	ReviewCollaboration	No
`title`	string	Yes
`sourceType`	`"deployed_url"` · `"localhost"`	Yes
`previewUrl`	string	Yes	Format: uri.
`deliveryMode`	`"auto"` · `"embedded"` · `"new_tab"`	No
`repo`	WebAppReviewRepo	No
`externalMetadata`	object	No

Call the endpoint

Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.

curl --request POST \
  'https://commentary.dev/api/v1/web-app-reviews' \
  --header 'Authorization: Bearer <your-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

Status	Meaning	Payload
`201`	Successful response.	object
`400`	The request was invalid.	ExternalError
`401`	Authentication is required.	ExternalError
`403`	The token or session does not have permission for this resource.	ExternalError
`404`	The resource was not found.	ExternalError
`429`	The request was rate limited.	ExternalError

Successful response fields

Field	Type	Required	Description
`ok`	`true`	No
`webAppReview`	WebAppReview	No
`reviewId`	string	No
`reviewUrl`	string	No	Format: uri.

Recover from errors

Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.

Operation ID: createWebAppReview. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.