Reviews

Invoke a configurable action on a review

The canonical decide endpoint (spec §3.1). Accepts any action defined on the review's template. Built-in action_id values: approve, reject, request_changes, cancel_iteration. Fires a review.action_taken webhook when a callback_url is set. Accepts both session (reviewer) and API-key (agent) authentication.

post/api/v1/reviews/{id}/action

Request

  • Base URL: https://api.gatewerk.com
  • URL: https://api.gatewerk.com/api/v1/reviews/{id}/action
  • Auth: HTTP bearer

Request body

action_idstring required

Preset action identifier. Built-in values: approve, reject, request_changes, cancel_iteration. Custom actions are defined on the template.

feedbackstring
edited_payloadJsonObject

Free-form JSON object.

versioninteger

Response

Action recorded. Review returned with updated status.

object'review' required
idstring required
project_idstring required
template_idstring nullable
template_slugstring required
payloadJsonObject required

Free-form JSON object.

suggested_valueJsonObject

Free-form JSON object.

approved_valueJsonObject

Free-form JSON object.

edited_payloadJsonObject

Free-form JSON object.

callback_urlstring nullable
priority'low' | 'normal' | 'high' | 'critical' required
status'pending' | 'awaiting_iteration' | 'decided' | 'expired' | 'archived' required

Canonical review status. Wire-format output is always one of these five values. Query-param status filter additionally accepts the legacy 'changes_requested' alias as a deprecated input for one minor version per spec §11.3 — removed in v2.0.

decision'approved' | 'rejected' | 'edited' | 'retried' | 'expired'
feedbackstring nullable
decided_bystring nullable
decided_by_verifiedboolean nullable

Whether decided_by names a confirmed identity. False only for a decision made through a PUBLIC review link, where the decider is the recipient_label the sharer typed and nothing verified it. Null for reviews decided before this field existed: render no claim rather than assuming unverified.

decided_atstring date-time nullable
current_versioninteger required
assigneestring nullable
metadataJsonObject

Free-form JSON object.

action_valuestring nullable
action_labelstring 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.