Create a change alert (webhook)

Subscribe a public https webhook to material changes on a domain, a cohort tag, or the whole catalog. Every delivery carries X-DomainDrift-Signature = HMAC-SHA256(secret, body). The signing secret is returned once. Email channel is not available yet and is rejected.

post/v1/alerts

Request

  • Base URL: https://domaindrift.io
  • URL: https://domaindrift.io/v1/alerts
  • Auth: API key in header X-DomainDrift-Key

Request body

scope_kind'domain' | 'tag' | 'catalog' required
scope_valuestring

domain, or tag "key"/"key:value"; omit for catalog

channel'webhook'
targetstring required

public https webhook URL

min_weightinteger

fire only when change significance >= this

type_prefixstring

optional change-type prefixes, comma-separated - any one matching fires. A prefix covers itself and its dotted children, so "tls" covers tls.issuer.changed but never tlsfoo.changed. e.g. "tls" or "dns, tls, whois"

Example request

{
  "target": "https://hooks.example.com/domaindrift"
}

Response

Created - body includes signing_secret (shown once)

Changes

No recorded changes to this operation across all 1 revision of this API.