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

_Webhook._

Delivered when enrolment_sync.halted 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._

- `enrolment_sync.halted.id` (string, required) — Equal to the webhook-id header and to the outbox event identifier. Deduplicate on it.
- `enrolment_sync.halted.type` (string, required)
- `enrolment_sync.halted.version` (integer, required)
- `enrolment_sync.halted.occurred_at` (string, required)
  - format `date-time`
- `enrolment_sync.halted.tenant` (object, required)
  - `enrolment_sync.halted.tenant.id` (string, required)
  - `enrolment_sync.halted.tenant.slug` (string, required)
- `enrolment_sync.halted.subscription_id` (string, required)
- `enrolment_sync.halted.livemode` (boolean, required)
- `enrolment_sync.halted.data` (object, required)
  - `enrolment_sync.halted.data.added` (integer, required)
    - min -9007199254740991; max 9007199254740991
  - `enrolment_sync.halted.data.failed` (integer, required)
    - min -9007199254740991; max 9007199254740991
  - `enrolment_sync.halted.data.halt_reason` (string, required)
  - `enrolment_sync.halted.data.instance_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)$`
  - `enrolment_sync.halted.data.mode` (string, required)
  - `enrolment_sync.halted.data.removed` (integer, required)
    - min -9007199254740991; max 9007199254740991
  - `enrolment_sync.halted.data.revived` (integer, required)
    - min -9007199254740991; max 9007199254740991
  - `enrolment_sync.halted.data.run_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)$`
  - `enrolment_sync.halted.data.updated` (integer, required)
    - min -9007199254740991; max 9007199254740991
- `enrolment_sync.halted.links` (map<string>, optional) — Where to read the current state of what the event is about.

## Example request

```json
{
  "id": "string",
  "type": "enrolment_sync.halted",
  "version": 1,
  "occurred_at": "2019-08-24T14:15:22Z",
  "tenant": {
    "id": "string",
    "slug": "string"
  },
  "subscription_id": "string",
  "livemode": true,
  "data": {
    "added": -9007199254740991,
    "failed": -9007199254740991,
    "halt_reason": "string",
    "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
    "mode": "string",
    "removed": -9007199254740991,
    "revived": -9007199254740991,
    "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
    "updated": -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/enrolment_sync.halted/index.md