Webhooks

Update a webhook subscription

Partially update a webhook subscription. Only provided fields are modified; omitted fields remain unchanged.

patch/v1/webhooks/{webhook_id}

Path parameters

webhook_idstring required

Request body

urlstring nullable

New HTTPS URL for webhook delivery. Must use HTTPS.

namestring nullable

New human-readable label (max 255 characters).

event_typestring nullable

Event type to subscribe to, in category.* format. Currently only deed.* is supported.

regionstring nullable

Geographic region in type:value format. Supported types: state:{code} (e.g., state:tx) for an entire state, or county:{state}.{name} (e.g., county:tx.travis) / county:{fips} (e.g., county:48453) for a single county. Currently only Texas and its counties are supported. Use the Regions API to discover valid values: GET /v1/regions/states and GET /v1/regions/states/{state}/counties.

Example request

{
  "url": "https://api.example.com/webhooks/wp-events",
  "name": "Updated deed alerts",
  "event_type": "deed.*",
  "region": "state:tx"
}

Response

Webhook updated successfully

Example response

{
  "result": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "url": "https://api.example.com/webhooks/wp-events",
    "name": "Austin metro deed alerts",
    "event_type": "deed.*",
    "region": "county:tx.travis",
    "status": "active",
    "created_at": "2026-01-15T09:30:00Z",
    "updated_at": "2026-02-20T14:45:00Z"
  }
}

Changes

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