Update Audit Report webhook settings

Changed on

Manage this account’s Audit Report notification settings. Requires eligible API key. Send one credential header and no query parameters. Send url, active and the current revision. A successful save increments revision; refresh after 409. HTTPS only; no credentials, fragments or redirects. Pending deliveries and retries use your latest saved endpoint.

post/sexoffender/report/live/webhook

Request

  • Base URL
    https://api.offenders.io
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

urlstring nullable required

Public HTTPS callback URL on port 443, without credentials or a fragment. Set null with active false to clear the endpoint.

activeboolean required
revisioninteger required

Use 0 for the first save. For later changes, use the latest revision returned by a successful save or GET. After 409 settings_changed, read the current settings before saving again.

Example request

{
  "url": "https://example.com/webhooks/offenders",
  "active": true,
  "revision": 0
}

Response

Current account setting and optional signature verification key.

urlstring nullable required

Configured callback URL; null before a URL has been saved.

activeboolean required
revisioninteger required
public_key_pemstring nullable required

Public key for optional Webhook signature verification for your account.

signature_header'X-Offenders-Webhook-Signature' required

Example response

{
  "url": null,
  "active": false,
  "revision": 0,
  "public_key_pem": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----",
  "signature_header": "X-Offenders-Webhook-Signature"
}

Changes