Webhooks

Create a webhook endpoint

Creates a new webhook subscription. The returned secret is shown ONCE — store it server-side and use it to verify every incoming delivery via the X-PropRaven-Signature header (HMAC-SHA256 over <unix_ms>.<raw_body>). Reject deliveries where |now - t| > 5min. Every request field is validated before anything is created; filter_value.parcel_ids entries are stored as canonical ids (state_fips:county_fips:parcel_id). Only active endpoints count toward your quota.

post/api/v1/webhooks

Request

  • Base URL: https://propraven.com
  • URL: https://propraven.com/api/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Customer endpoint. https:// only.

event_typesstring[] required

Event types to subscribe to. All three event types are live: create accepts each of them and PropRaven emits each of them.

filter_kind'parcel_ids' | 'state_fips' | 'county_fips' required
descriptionstring nullable

Optional human-readable label for your dashboard.

Response

Webhook created. Response includes the one-time secret.

idstring uuid
urlstring uri

Customer endpoint. Must be https://.

secret_prefixstring

First 14 characters of the secret (whsec_ + 8 hex). Identifies the endpoint; the full secret is shown only in the create response.

event_typesstring[]
filter_kind'parcel_ids' | 'state_fips' | 'county_fips'
descriptionstring nullable
is_activeboolean

false after DELETE (a soft disable).

created_atstring date-time
disabled_atstring date-time nullable
disabled_reasonstring nullable

user when disabled with DELETE; null while active.

deliveries_attemptedinteger
deliveries_succeededinteger
last_delivery_atstring date-time nullable
last_success_atstring date-time nullable
identity_status'canonical' | 'legacy_bare_parcel_ids'

parcel_ids endpoints only. legacy_bare_parcel_ids: the endpoint was created before 2026-09-22 with bare parcel numbers, and those that do not name exactly one parcel are not matched; recreate it with canonical ids.

secretstring required

Shown once. Copy and store server-side immediately. Used to sign every outgoing delivery.

hintstring required

Signature-verification reminder.

Changes

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