Skip to main content
WEBHOOK
evaluation-completed
{
  "organizationId": "<string>",
  "workspaceId": "<string>",
  "promotionId": "<string>",
  "evaluationId": "<string>",
  "status": "succeeded",
  "reviewRequired": true,
  "overallAssessment": "<string>",
  "issues": [
    {
      "recommendation": "<string>",
      "rationale": "<string>",
      "severity": "LOW",
      "citedRules": [
        {
          "id": "<string>",
          "name": "<string>",
          "product": "<string>",
          "channel": "<string>"
        }
      ],
      "location": {
        "type": "text",
        "content": "<string>",
        "pageNumber": 123,
        "timestamp": "<string>"
      }
    }
  ],
  "promotionVersionId": "<string>",
  "metadata": {},
  "correlationId": "<string>"
}

Authorizations

Authorization
string
header
required

Unkey API key passed as Bearer token

Body

application/json
organizationId
string
required
Minimum string length: 1
workspaceId
string
required
Minimum string length: 1
promotionId
string
required
Minimum string length: 1
evaluationId
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
succeeded,
failed
reviewRequired
boolean
required
overallAssessment
string
required
issues
object[]
required
promotionVersionId
string
metadata
object
correlationId
string

Response

200

Webhook acknowledged