Response webhooks

Each review submission triggers a webhook event. Set up the webhook URL that should be called as described here.

Payload

The webhook is a POST request to your endpoint. Here is an example of the data we might send.

info

The responseValues and meta properties will depend on the fields you added to your review template and the meta data sent in your request.

Content-Type: application/json

{
    "type": "review",
    "accountId": "abFMvLv4HafQymWxKDAov",
    "formId": "123456abcdef",
    "formName": "Review AI Draft",
    "reviewId": "123456abcdef",
    "response": "approved",
    "respondingUser": "[email protected]",
    "respondedAt": "2024-10-05T14:48:00.000Z",
    "responseValues": {
        "blogPost": {
            "value": "Regarding the very interesting topic of...",
            "wasEdited": true
        },
        "rating": {
            "value": 7.5,
            "wasEdited": false
        },
        "decisionSelect": {
            "value": "approve"
        }
    },
    "meta": {
        "example": "LLM thread id"
    },
    "gthLinkToReview": "https://app.gotohuman.com/accounts/abFMvLv4HafQymWxKDAov/ReviewRequests/123456abcdef"
}

Retries

All review requests and their corresponding webhook events can be found on each review template's detail page. There you can monitor the status of webhook deliveries, which indicates whether they succeeded or failed.

If a webhook delivery fails, a Retry button will appear next to the failed event. You can click this button to manually retry sending the webhook.

Updating webhook URLs

If you entered a static webhook URL to call, the retry attempt will use the latest URL you entered in your template settings. This allows you to update a failing URL and then retry the webhook delivery.

n8n

If you are using n8n to build your AI workflow, read how to handle completed reviews in our n8n integration guide.

Make

When using Make to create your workflow, read our Make integration guide on how to handle submitted reviews.