Monitoring

Update a company-record monitor

Supplying a non-null webhook_url returns the current signing secret. A retry with the same idempotency key and body returns the exact completed response, including that signing secret.

patch/monitors/{monitor_id}

Request

Base URL: https://vatfind.com/v1
URL: https://vatfind.com/v1/monitors/{monitor_id}
Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable key for safe retries, scoped to workspace, environment, and operation.

Request body

status'active' | 'paused'

cadence'daily' | 'weekly' | 'monthly'

watched_fieldsMonitorWatchedField[]

webhook_urlstring uri nullable

Public HTTPS endpoint, or null to disable delivery. Credentials, IP literals, and local, test, internal, or localhost names are rejected.

Response

Updated monitor and webhook signing secret when a non-null webhook_url was explicitly supplied

webhook_signing_secretstring

Example response

{
  "monitor": {
    "identifier": {
      "country_code": "GB"
    }
  }
}

Changes

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