{
"organizationId": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"promotionId": "<string>",
"evaluationId": "<string>",
"reviewRequired": true,
"overallAssessment": "<string>",
"issues": [
{
"recommendation": "<string>",
"rationale": "<string>",
"commentId": "<string>",
"citedRules": [
{
"id": "<string>",
"name": "<string>",
"product": "<string>",
"channel": "<string>"
}
]
}
],
"promotionVersionId": "<string>",
"metadata": {},
"correlationId": "<string>"
}Webhooks
Evaluation completed
Sent when a compliance evaluation finishes (success or failure). Comment-backed issues normally include a commentId that can be sent as parentCommentId when posting a reply; replayed deliveries may omit it. If the reply briefly returns PARENT_NOT_FOUND, retry because comment indexing is asynchronous.
WEBHOOK
evaluation-completed
{
"organizationId": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"promotionId": "<string>",
"evaluationId": "<string>",
"reviewRequired": true,
"overallAssessment": "<string>",
"issues": [
{
"recommendation": "<string>",
"rationale": "<string>",
"commentId": "<string>",
"citedRules": [
{
"id": "<string>",
"name": "<string>",
"product": "<string>",
"channel": "<string>"
}
]
}
],
"promotionVersionId": "<string>",
"metadata": {},
"correlationId": "<string>"
}Authorizations
API key passed as Bearer token
Body
application/json
Minimum string length:
1Minimum string length:
1Minimum string length:
1succeeded or failed. When failed, issues is empty and reviewRequired is false. Check status before you read either field. Only a succeeded result with reviewRequired: false is a pass.
Available options:
succeeded, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
200
Webhook acknowledged
Was this page helpful?