Manage change webhooks
manage_webhooksAdmin-only change-feed webhooks. list shows status/last delivery. create starts signed JSON batches of read_changes metadata: object, record, verb and changed field names, never values; oldest first, after a minute. update patches URL, description or object_types (null=all). pause/resume stop/restart delivery; rotate_secret issues a new secret; test posts a ping now; delete removes the webhook. Creating, changing URL, rotating or deleting previews first and needs confirm:true. Failures retry with backoff, disabling after a day; list gives the reason and resume re-enables. Up to 10 per workspace; HTTPS public-host URLs only.
When to use: An admin connects another system to CRM changes without polling.
Example: Set up https://hooks.example.com/capable.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | create / update: the https URL to post to. | |
| action | Yes | list, create, update, pause, resume, rotate_secret, test or delete. One of: list | create | update | pause | resume | rotate_secret | test | delete. | |
| confirm | No | create, a url change, rotate_secret and delete apply only with confirm:true; without it the call previews. | |
| webhook_id | No | Every action but list and create: which webhook. | |
| description | No | create / update: what this webhook feeds (null clears it). | |
| object_types | No | create / update: only these objects (account, contact, opportunity, …, a custom object's key); null or omitted on create = every object. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| action | No | ||
| secret | No | ||
| applied | No | ||
| webhook | No | ||
| delivery | No | ||
| webhooks | No | ||
| requires_confirm | No | ||
| signing_configured | No |