---
title: "Incident webhook: POST {webhook, domains?} (https, public host; leave domains out for every domain, or list up to 100). When a claim holder declares or clears an incident, each matching webhook is POSTed a signed event (kind crawlcheck-incident-event; events incident.declared, incident.cleared, incident.test). Returns the subscription id and a token shown once."
method: POST
path: "/api/v1/incident/subscribe"
---

# Incident webhook: POST {webhook, domains?} (https, public host; leave domains out for every domain, or list up to 100). When a claim holder declares or clears an incident, each matching webhook is POSTed a signed event (kind crawlcheck-incident-event; events incident.declared, incident.cleared, incident.test). Returns the subscription id and a token shown once.

`POST /api/v1/incident/subscribe`

## Request

- Base URL: `https://crawlcheck.io`
- URL: `https://crawlcheck.io/api/v1/incident/subscribe`
- Auth: none required

## Request body

- object
  - `webhook` string, required
  - `domains` string[]

## Response `201`

subscribed

- object, nullable
  - `ok` boolean, nullable
  - `id` unknown
  - `token` unknown
  - `webhook_host` string, nullable
  - `domains` string[], nullable
  - `events` string[], nullable
  - `delivered` number, nullable
  - `consecutive_failures` number, nullable

---

[API](https://skmtc.dev/crawlcheck/apis/crawlcheck-api.md) · [All operations](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/revisions/57acbd6d4489?raw)