Reviewers

Register a reviewer agent

Pin a reviewer to one report (report_id, you must own it) or omit report_id for owner-wide review. reviewer_auth_header is encrypted at rest and never returned. Scope: routines.

post/reviewers

Request

  • Base URL: https://commareports.com/api/v1
  • URL: https://commareports.com/api/v1/reviewers
  • Auth: HTTP bearer

Request body

namestring

Defaults to 'Untitled reviewer'.

reviewer_urlstring uri required

http(s) endpoint that receives ReviewRequest payloads.

report_idstring uuid nullable

Pin to one report (requires edit access) or null for owner-wide.

reviewer_auth_headerstring nullable

Sent as the Authorization header to reviewer_url. Encrypted at rest; never returned.

promptstring nullable
enabledboolean
auto_on_revisionboolean

Response

Reviewer created.

idstring uuid required
report_idstring uuid nullable

null = applies to every report the owner has.

namestring required
reviewer_urlstring uri required
promptstring nullable
enabledboolean required
auto_on_revisionboolean required

Run automatically whenever a new revision lands.

last_run_atstring date-time nullable
last_run_statusstring nullable
last_run_errorstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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