---
title: "badge.awarded"
description: "Delivered when badge.awarded 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 badge.awarded`

_Webhook._

Delivered when badge.awarded 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._

- `badge.awarded.id` (string, required) — Equal to the webhook-id header and to the outbox event identifier. Deduplicate on it.
- `badge.awarded.type` (string, required)
- `badge.awarded.version` (integer, required)
- `badge.awarded.occurred_at` (string, required)
  - format `date-time`
- `badge.awarded.tenant` (object, required)
  - `badge.awarded.tenant.id` (string, required)
  - `badge.awarded.tenant.slug` (string, required)
- `badge.awarded.subscription_id` (string, required)
- `badge.awarded.livemode` (boolean, required)
- `badge.awarded.data` (object, required)
  - `badge.awarded.data.assertion_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)$`
  - `badge.awarded.data.awarded_by` (any of, required)
    - any of: `string`, `null`
  - `badge.awarded.data.badge_class_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)$`
  - `badge.awarded.data.spec_version` (string, required)
  - `badge.awarded.data.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)$`
  - `badge.awarded.data.verification_uid` (string, required)
- `badge.awarded.links` (map<string>, optional) — Where to read the current state of what the event is about.

## Example request

```json
{
  "id": "string",
  "type": "badge.awarded",
  "version": 1,
  "occurred_at": "2019-08-24T14:15:22Z",
  "tenant": {
    "id": "string",
    "slug": "string"
  },
  "subscription_id": "string",
  "livemode": true,
  "data": {
    "assertion_id": "71686565-a0bc-4e1c-83d4-29f1f25e805b",
    "awarded_by": "93dc00d8-812f-4968-aa22-798650e32402",
    "badge_class_id": "8f1fd395-e52d-4095-aa7e-fffa69cb4734",
    "spec_version": "string",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "verification_uid": "string"
  },
  "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/badge.awarded/index.md