GEgetsales
webhooks

Update webhook

Edit a subscription: name, target_url, events and filters are full replacements; status on | off switches it (off cancels its pending deliveries; on after a failed revives it and resets the counter, but re-issues nothing). failed is never set by hand and the secret is not writable (rotation is admin-internal). At least one field.

Contract:

  • MCP tool update_webhook, registry package mcp.integrations/webhooks, mount integrations.webhooks.
  • Operation update, response envelope update.
  • Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
patch/api/webhooks/{sid}

Request

  • Base URL
    https://beta.getsales.io/integrations/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Webhook sid (wh_hk_...).

Request body

namestring

New name, 1..255 chars.

target_urlstring

https only, a public host; unique per team.

eventsstring[]

FULL replacement of the subscribed types.

status'on' | 'off'

on | off; failed is platform-set.

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.

Changes

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