Read 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. The default is url null, active false and revision 0.

get/sexoffender/report/live/webhook

Request

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

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