Create review

{
  "agentId": "ag123456",
  "formId": "abcdef12345",
  "data": {
    "crmUpdate": {
      "entryId": "123456abcdef",
      "amount": 42000,
      "stage": "proposal"
    }
  },
  "config": {
    "fields": {
      "stageSelect": {
        "options": [
          { "id": "proposal", "label": "Proposal" },
          { "id": "negotiation", "label": "Negotiation" },
          { "id": "won", "label": "Won" }
        ]
      }
    }
  },
  "meta": {
    "example": "LLM thread id"
  },
  "title": "Review AI draft",
  "sessionId": "session789abcdef",
  "assignTo": ["[email protected]"],
  "webhookUrl": "https://example.com/webhooks/gotohuman",
  "autoApprove": false
}

{
  "reviewId": "123456abcdef",
  "sessionId": "session789abcdef",
  "gthLink": "https://app.gotohuman.com/accounts/acc12345678/inbox/agents/all/reviews/123456abcdef",
  "extReviewerLinks": [
    {
      "email": "[email protected]",
      "link": "https://app.gotohuman.com/..."
    }
  ]
}

POST

reviews

{
  "agentId": "ag123456",
  "formId": "abcdef12345",
  "data": {
    "crmUpdate": {
      "entryId": "123456abcdef",
      "amount": 42000,
      "stage": "proposal"
    }
  },
  "config": {
    "fields": {
      "stageSelect": {
        "options": [
          { "id": "proposal", "label": "Proposal" },
          { "id": "negotiation", "label": "Negotiation" },
          { "id": "won", "label": "Won" }
        ]
      }
    }
  },
  "meta": {
    "example": "LLM thread id"
  },
  "title": "Review AI draft",
  "sessionId": "session789abcdef",
  "assignTo": ["[email protected]"],
  "webhookUrl": "https://example.com/webhooks/gotohuman",
  "autoApprove": false
}

{
  "reviewId": "123456abcdef",
  "sessionId": "session789abcdef",
  "gthLink": "https://app.gotohuman.com/accounts/acc12345678/inbox/agents/all/reviews/123456abcdef",
  "extReviewerLinks": [
    {
      "email": "[email protected]",
      "link": "https://app.gotohuman.com/..."
    }
  ]
}

See Introduction for the base URL and authentication.

Body

string

required

The ID of the agent identity you created in gotoHuman.

string

required

The ID of your review type.

object

required

The data to review.You can either send the data in its existing shape and map each field in the review type to the corresponding property path (e.g. map a dropdown field stageSelect to the path crmUpdate.stage). Or you use the default shape shown in the example request after adding your fields.

Input fields that you don’t send any value for will be hidden or show as empty inputs depending on the field’s setting.

object

Dynamic configuration for certain field types:

Dropdown, Checkboxes, Buttons: Available options
Image fields: Transformations and base64 flag
Link: Link text

Check the “Review Config” section or config property in the example request of your review type in the web editor to see available settings, for example:

{
  "fields": {
    "stageSelect": {
      "options": [
        { "id": "proposal", "label": "Proposal" },
        { "id": "negotiation", "label": "Negotiation" },
        { "id": "won", "label": "Won" }
      ]
    }
  }
}

string

A custom title for the review request. This title is displayed in the Agent Inbox and in notification emails and Slack messages, making it easier for reviewers to identify pending reviews.

string

Links multiple reviews of the same session or workflow run.When a run started from a trigger form, use the sessionId from its webhook event.

object

Additional data that should not be part of the review but that you want to receive back in the webhook.

string[]

Email addresses of reviewers from your organization to assign. Read more.

string

Webhook URL for this request. You can do this instead of setting the webhook on the review type or on the agent.

boolean

Set to automatically approve the review request.
You can also set this on the review type.

{
  "agentId": "ag123456",
  "formId": "abcdef12345",
  "data": {
    "crmUpdate": {
      "entryId": "123456abcdef",
      "amount": 42000,
      "stage": "proposal"
    }
  },
  "config": {
    "fields": {
      "stageSelect": {
        "options": [
          { "id": "proposal", "label": "Proposal" },
          { "id": "negotiation", "label": "Negotiation" },
          { "id": "won", "label": "Won" }
        ]
      }
    }
  },
  "meta": {
    "example": "LLM thread id"
  },
  "title": "Review AI draft",
  "sessionId": "session789abcdef",
  "assignTo": ["[email protected]"],
  "webhookUrl": "https://example.com/webhooks/gotohuman",
  "autoApprove": false
}

{
  "reviewId": "123456abcdef",
  "sessionId": "session789abcdef",
  "gthLink": "https://app.gotohuman.com/accounts/acc12345678/inbox/agents/all/reviews/123456abcdef",
  "extReviewerLinks": [
    {
      "email": "[email protected]",
      "link": "https://app.gotohuman.com/..."
    }
  ]
}

Response

The API responds with a link to the pending review.

string

ID of the created review.

string

Session this review belongs to. Reuse it in later review requests to link multiple steps of the same session or workflow run.

string

Link to open the pending review in gotoHuman.

object[]

Included when external reviewers have been assigned to the review request.

Show properties

string

Email address of the external reviewer.

string

Unique link for that reviewer.

GET STARTED

Human reviews

Notifications

Integrations

API Reference

Examples

More

Body

Response

​Body

​Response

Body

Response