> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adclear.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhook events

> Every event Adclear can send to your webhooks, with an example of each and what the details mean.

Adclear can send nine kinds of event. Each one arrives with the same outer details, like which event it is and when it happened. The details about what happened are inside `data`.

Most events include the same few things: the promotion, the version of it, and who did it. Those are explained once under [Shared details](#shared-details). Each event below then lists only what's different about it.

## A full example

Here is everything Adclear sends when a reviewer rejects a promotion.

```json theme={null}
{
  "apiVersion": "1",
  "id": "evt_4a1f9c02-7b31-4f5d-9c6a-2e8b0d7f1a34",
  "type": "review.rejected",
  "occurredAt": "2026-11-03T10:42:17.000Z",
  "deliveryId": "0f2c9d51-8a44-4c7e-b0d2-6f9a3c5e1b78",
  "organizationId": "org_2kPq8XrTn5Lm3Wv",
  "workspaceId": "7c3e1a90-2b4d-4f6e-9a18-5d0c3b7e2f41",
  "data": {
    "promotion": {
      "id": "b5d2e7a1-9c34-4f80-a6b2-1e7d9c0f3a55",
      "name": "Spring savings email",
      "status": "rejected",
      "countryId": "3f9a1c2e-6b7d-4e8a-9c05-2d1f4b6a8e73",
      "details": "Email to existing customers announcing the new easy-access rate.",
      "isFinancialPromotion": true,
      "evergreen": false,
      "publicId": "42",
      "deadline": "2026-11-10",
      "approvedAt": null,
      "goLiveDate": "2026-11-14T09:00:00.000Z",
      "endDate": null,
      "nextReviewDate": null,
      "uploaderUserId": "user_2nHq7TzVb1Kc9Xa",
      "reviewerUserId": "user_2pRw4LmYs8Dj6Fe",
      "createdAt": "2026-11-01T14:05:00.000Z",
      "updatedAt": "2026-11-03T10:42:17.000Z"
    },
    "version": {
      "id": "e81c4b2d-5f60-4a97-b3d1-0c2e9f7a6b14",
      "promotionId": "b5d2e7a1-9c34-4f80-a6b2-1e7d9c0f3a55",
      "version": 2,
      "status": "rejected",
      "format": "email",
      "reviewType": "single",
      "details": null,
      "conditionalReason": null,
      "isFinprom": true,
      "submitted": true,
      "deadline": "2026-11-10",
      "uploaderUserId": "user_2nHq7TzVb1Kc9Xa",
      "reviewerUserId": "user_2pRw4LmYs8Dj6Fe",
      "externalMetadata": { "crmCampaignId": "SPR-2026-07" },
      "createdAt": "2026-11-02T16:20:00.000Z",
      "updatedAt": "2026-11-03T10:42:17.000Z"
    },
    "decidedBy": { "userId": "user_2pRw4LmYs8Dj6Fe" },
    "rationale": "Unclear, not Fair or Misleading: The headline rate is not shown alongside the AER."
  }
}
```

To link back to the promotion in Adclear, use both IDs: `https://app.adclear.ai/v2/promotion/{data.promotion.id}/version/{data.version.id}`.

## Shared details

> [accordion] promotion
>
> The promotion the event is about. The promotion's actual wording and images are not included.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `id` | ID | Promotion ID |
> | `name` | Text | Promotion name |
> | `status` | Status | Current status. See [Status values](#status-values) |
> | `countryId` | ID, or empty | Country the promotion targets |
> | `details` | Text, or empty | Brief entered by the uploader |
> | `isFinancialPromotion` | True or false | Whether it is a financial promotion |
> | `evergreen` | True or false | Whether it runs without an end date |
> | `publicId` | Text, or empty | Reference shown in the app, for example `42` or `45-A` |
> | `deadline` | Text, or empty | Review deadline |
> | `approvedAt` | Date and time, or empty | When it was approved. May be missing |
> | `goLiveDate` | Date and time, or empty | Planned go-live date. May be missing |
> | `endDate` | Date and time, or empty | Planned end date. May be missing |
> | `nextReviewDate` | Date and time, or empty | Next periodic review. May be missing |
> | `uploaderUserId` | Text | User who uploaded it |
> | `reviewerUserId` | Text, or empty | Assigned reviewer |
> | `createdAt`, `updatedAt` | Date and time | Record timestamps |

> [accordion] version
>
> One version of the promotion. `promotionId` points back to the parent.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `id` | ID | Version ID |
> | `promotionId` | ID | Parent promotion ID |
> | `version` | Number, or empty | Version number. Null on older records |
> | `status` | Status | Status of this version. See [Status values](#status-values) |
> | `format` | Text | Format of the uploaded content |
> | `reviewType` | Text | `single`, `parallel` or `sequential` |
> | `details` | Text, or empty | Notes on this version |
> | `conditionalReason` | Text, or empty | Condition recorded with a conditional approval |
> | `isFinprom` | True or false | Whether this version is a financial promotion |
> | `submitted` | True or false | Whether it has been submitted for review |
> | `deadline` | Text, or empty | Review deadline |
> | `uploaderUserId` | Text | User who uploaded it |
> | `reviewerUserId` | Text, or empty | Assigned reviewer |
> | `externalMetadata` | List of pairs, or empty | Your own labels, if you added any when creating it through the API. May be missing |
> | `createdAt`, `updatedAt` | Date and time | Record timestamps |

> [accordion] Person (changedBy, submittedBy, decidedBy)
>
> The person who took the action.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `userId` | Text | Adclear user ID |
> | `name` | Text | Their name. Not always included, so don't rely on it |
> | `externalUserId` | Text | Your own ID for the person, when the action came through the Adclear API |

> [accordion] comment
>
> | Field | Kind | What it is |
> | - | - | - |
> | `id` | Text | Comment ID |
> | `threadId` | Text | Thread the comment belongs to |
> | `authorUserId` | Text | User who wrote it |
> | `content` | Text | Comment text |
> | `isComplianceComment` | True or false | True when the person who wrote it can review promotions for that country. Adclear's own findings and replies to them count too |
> | `createdAt` | Date and time | When it was posted |

> [accordion] Evaluation issue
>
> One problem Adclear found when it checked a promotion.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `recommendation` | Text | What to change |
> | `rationale` | Text | Why |
> | `severity` | Text | `LOW`, `MEDIUM` or `HIGH` |
> | `commentId` | Text | The comment that holds the issue in Adclear. Usually present |
> | `citedRules` | List | The rules it relates to, each with an `id` and sometimes a `name`, `product` and `channel` |
> | `location` | Group | Where the problem is. `content` is the part it's about. `type` is `text`, `image`, `general` or `insertion`. Sometimes includes a `pageNumber` or `timestamp` |

### Status values

`status`, `previousStatus` and `newStatus` use these values: `saved`, `pending`, `expired`, `in_review`, `approved`, `rejected`, `changes_needed`, `conditionally_approved`, `escalated`, `reviewing_risk`, `risk_accepted`. See [Promotion statuses](https://docs.adclear.ai/promotion-statuses.md) for what each one means.

## Events

Every event includes `promotion` and `version`. The tables show what each one adds.

> [accordion] promotion.created
>
> A promotion was created, along with its first version. Nothing extra is added. The test event you send from Settings is one of these, with IDs made of zeros.

> [accordion] promotion.status\_changed
>
> A promotion version moved to a new status, for example from `in_review` to `approved`.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `previousStatus` | Status, or empty | Status before the change |
> | `newStatus` | Status | Status after the change |
> | `changedBy` | Person | Who changed it |
>
> ```json theme={null}
> "previousStatus": "in_review",
> "newStatus": "approved",
> "changedBy": { "userId": "user_2pRw4LmYs8Dj6Fe" }
> ```

> [accordion] promotion.version\_created
>
> A new version was added to an existing promotion.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `previousVersionId` | ID, or empty | The version this one follows |

> [accordion] review\.submitted
>
> A version was submitted and is waiting on a reviewer.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `submittedBy` | Person | Who submitted it |
> | `reviewerUserId` | Text, or empty | Reviewer it was assigned to, if any |

> [accordion] review\.approved
>
> A reviewer approved a version, either outright or with conditions.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `decidedBy` | Person | Who approved it |
> | `decision` | Text | `approved`, `conditionally_approved` or `risk_accepted` |
> | `conditionalReason` | Text, or empty | The condition, for a conditional approval |
>
> ```json theme={null}
> "decidedBy": { "userId": "user_2pRw4LmYs8Dj6Fe" },
> "decision": "conditionally_approved",
> "conditionalReason": "Add the representative example before the next send."
> ```

> [accordion] review\.changes\_requested
>
> A reviewer asked for changes before the version can be approved.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `decidedBy` | Person | Who asked for changes |
> | `rationale` | Text, or empty | The reasons the reviewer picked. A note they added follows a colon, and several reasons are split by `; `. For example `Unclear, not Fair or Misleading: Show the AER next to the rate` |

> [accordion] review\.rejected
>
> A reviewer rejected a version. Same fields as `review.changes_requested`. See [A full example](#a-full-example).

> [accordion] comment.created
>
> Someone added a comment to a version.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `comment` | Comment | The new comment |
>
> ```json theme={null}
> "comment": {
>   "id": "cm_8Hd2Lq",
>   "threadId": "th_5Vb9Ze",
>   "authorUserId": "user_2pRw4LmYs8Dj6Fe",
>   "content": "Please move the risk warning above the fold.",
>   "isComplianceComment": true,
>   "createdAt": "2026-11-03T10:40:02.000Z"
> }
> ```

> [accordion] evaluation.completed
>
> Adclear finished checking a promotion, whether the check worked or not.
>
> | Field | Kind | What it is |
> | - | - | - |
> | `evaluationId` | Text | Evaluation ID |
> | `status` | Text | `succeeded` or `failed` |
> | `reviewRequired` | True or false | Whether a person needs to review it |
> | `overallAssessment` | Text | A short label for the result, such as `Requires Review` or `No Modifications Required` |
> | `issues` | List | The problems found. See [Evaluation issue](#shared-details) |
>
> ```json theme={null}
> "evaluationId": "ev_3c9b7f12",
> "status": "succeeded",
> "reviewRequired": true,
> "overallAssessment": "Requires Review",
> "issues": [
>   {
>     "recommendation": "Show the AER next to the headline rate.",
>     "rationale": "The headline rate appears without the AER, which could mislead.",
>     "severity": "HIGH",
>     "commentId": "cm_4Tq1Np",
>     "citedRules": [{ "id": "rule_17", "name": "Interest rate prominence" }],
>     "location": { "type": "text", "content": "Earn 5.1% on your savings" }
>   }
> ]
> ```

## Related pages

> [card] [Webhooks](https://docs.adclear.ai/developer/webhooks.md)
>
> How webhooks are sent, checked and retried.

> [card] [Webhook recipes](https://docs.adclear.ai/developer/webhook-recipes.md)
>
> Examples in Zapier, Slack and Jira.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.