Skip to content

Ask for a review now

POST
/api/orgs/{org}/projects/{project}/review
curl --request POST \
--url https://api-dev.wrktr.com/api/orgs/example/projects/example/review \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "example" }'

The review agent reviews the current head now, replacing a review already there. It reviews by itself after each push, once the checks finish; this is for a review that failed, or a fresh look.

org
required
string
project
required
string
Media typeapplication/json
object
branch
required
string
Examplegenerated
{
"branch": "example"
}

Success

Media typeapplication/json
object
ok
required
boolean
Examplegenerated
{
"ok": true
}

Unauthorized

Media typeapplication/json
object
_tag
required
string
Allowed values: Unauthorized
message
required
string
Example
{
"_tag": "Unauthorized"
}

ProjectNotFound | BranchNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ProjectNotFound
project
required
string
Example
{
"_tag": "ProjectNotFound"
}