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

_Webhook._

Delivered when gradebook.imported 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._

- `gradebook.imported.id` (string, required) — Equal to the webhook-id header and to the outbox event identifier. Deduplicate on it.
- `gradebook.imported.type` (string, required)
- `gradebook.imported.version` (integer, required)
- `gradebook.imported.occurred_at` (string, required)
  - format `date-time`
- `gradebook.imported.tenant` (object, required)
  - `gradebook.imported.tenant.id` (string, required)
  - `gradebook.imported.tenant.slug` (string, required)
- `gradebook.imported.subscription_id` (string, required)
- `gradebook.imported.livemode` (boolean, required)
- `gradebook.imported.data` (object, required)
  - `gradebook.imported.data.batch_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)$`
  - `gradebook.imported.data.conflict_rule` (string, required)
  - `gradebook.imported.data.course_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)$`
  - `gradebook.imported.data.matched` (integer, required)
    - min -9007199254740991; max 9007199254740991
  - `gradebook.imported.data.skipped` (integer, required)
    - min -9007199254740991; max 9007199254740991
  - `gradebook.imported.data.unmatched` (integer, required)
    - min -9007199254740991; max 9007199254740991
  - `gradebook.imported.data.written` (integer, required)
    - min -9007199254740991; max 9007199254740991
- `gradebook.imported.links` (map<string>, optional) — Where to read the current state of what the event is about.

## Example request

```json
{
  "id": "string",
  "type": "gradebook.imported",
  "version": 1,
  "occurred_at": "2019-08-24T14:15:22Z",
  "tenant": {
    "id": "string",
    "slug": "string"
  },
  "subscription_id": "string",
  "livemode": true,
  "data": {
    "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
    "conflict_rule": "string",
    "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
    "matched": -9007199254740991,
    "skipped": -9007199254740991,
    "unmatched": -9007199254740991,
    "written": -9007199254740991
  },
  "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/gradebook.imported/index.md