Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Job Visit Webhook Api → Patch Api Contractors Job Visits Webhooks Webhook

AI-generated

Summary

Update an existing Job Visit Webhook by specifying its ID and modifying any subset of its properties such as URL, event type, payload, columns changed, description, or active status.

Inputs

  • Webhook (required) — The numeric ID of the Job Visit Webhook to update.
  • Url — New URL for the webhook; omit or set as 'DO_NOT_UPDATE' to leave unchanged.
  • Event — Event type triggering the webhook (e.g., 'created', 'updated'). Use 'DO_NOT_UPDATE' to keep the current value.
  • Payload — JSON object defining the payload sent by the webhook. Use 'DO_NOT_UPDATE' to retain original.
  • Columns Changed — JSON object specifying which columns changed to trigger the webhook; optional, can skip updating this field.
  • Description — Text description of the webhook; setting to 'DO_NOT_UPDATE' prevents modification.
  • Active — String representing active status; default 'DO_NOT_UPDATE' leaves unchanged.

Output shape

a single updated webhook record as returned by the API

Only fields provided with values other than 'DO_NOT_UPDATE' are included in the update request body. The operation requires the webhook ID and credentials. Optional request settings such as batching, proxy, timeout, and SSL handling can be adjusted via node settings.

Links

Discussion