---
title: "rating.recorded"
description: "Delivered when rating.recorded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock."
image: "https://docs.quirelms.com/og.png"
---

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

Path: Quire API

`POST rating.recorded`

_Webhook._

Delivered when rating.recorded occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock.

## Request body

_Required._

- `rating.recorded.id` (string, required) — Equal to the webhook-id header and to the outbox event identifier. Deduplicate on it.
- `rating.recorded.type` (string, required)
- `rating.recorded.version` (integer, required)
- `rating.recorded.occurred_at` (string, required)
  - format `date-time`
- `rating.recorded.tenant` (object, required)
  - `rating.recorded.tenant.id` (string, required)
  - `rating.recorded.tenant.slug` (string, required)
- `rating.recorded.subscription_id` (string, required)
- `rating.recorded.livemode` (boolean, required)
- `rating.recorded.data` (object, required)
  - `rating.recorded.data.activity_id` (string, required)
    - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
  - `rating.recorded.data.item_id` (string, required)
    - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
  - `rating.recorded.data.item_kind` (string, required)
    - minLength 1
  - `rating.recorded.data.previous_value` (number | null, required)
  - `rating.recorded.data.rated_user_id` (string, required)
    - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
  - `rating.recorded.data.rater_id` (string, required)
    - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
  - `rating.recorded.data.value` (number, required)
- `rating.recorded.links` (map<string>, optional) — Where to read the current state of what the event is about.

## Example request

```json
{
  "id": "string",
  "type": "rating.recorded",
  "version": 1,
  "occurred_at": "2019-08-24T14:15:22Z",
  "tenant": {
    "id": "string",
    "slug": "string"
  },
  "subscription_id": "string",
  "livemode": true,
  "data": {
    "activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
    "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
    "item_kind": "string",
    "previous_value": 0,
    "rated_user_id": "e08cad39-7827-45df-998e-eece3aeda6bf",
    "rater_id": "39939b5c-3149-4282-bc7b-eeae48d24338",
    "value": 0
  },
  "links": {
    "property1": "http://example.com",
    "property2": "http://example.com"
  }
}
```

## Responses

### 2XX

Any 2xx acknowledges the delivery. A 410 disables the subscription. Anything else is retried with exponential backoff and full jitter over about 36 hours.


Source: https://docs.quirelms.com/api/webhooks/rating.recorded/index.md