Webhooks

Get a single webhook endpoint

Returns one endpoint as the same snake_case record GET /webhooks lists (the Webhook schema). The secret is never returned.

get/api/v1/webhooks/{id}

Request

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

Path parameters

idstring uuid required

Webhook endpoint ID.

Response

Webhook endpoint returned.

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.

Changes

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