Grist Tools

Grist Update Webhook

Update an existing webhook configuration for a Grist document. Use to modify webhook settings such as URL, event types, enabled status, or target table. Requires valid document ID (from GRIST_LIST_WORKSPACES) and webhook ID (from GRIST_LIST_WEBHOOKS). Only provided fields will b…

Write ActionRisk level 2 of 5API key connectionFree Action

Use Grist Update Webhook

Owner App

Grist ToolsApp

Required inputs

urlstring

Destination URL to receive webhook POST requests when events occur.

memostring

Longer description for the webhook

namestring

Short descriptive name for the webhook

doc_idRequiredstring

The document ID (a short URL-safe string, e.g., 'rsUfVdgSXSL3UpmhYq3tAe') containing the webhook. Obtain from GRIST_LIST_WORKSPACES or GRIST_CREATE_DOCUMENT.

enabledboolean

Whether the webhook is active. Set to false to disable without deleting.

tableIdstring

Table ID to monitor for changes (e.g., 'Table1', 'Products'). Get table IDs using GRIST_LIST_TABLES.

eventTypesarray

List of events that trigger the webhook. Valid values: 'add' (new records), 'update' (modified records).

webhook_idRequiredstring

UUID identifier of the webhook to update (e.g., '0024e0d2-8ecb-4748-b89f-7b15824b9778'). Obtain from GRIST_LIST_WEBHOOKS or GRIST_CREATE_WEBHOOK.

isReadyColumnstring

Column ID of a boolean column (e.g., 'Ready'); webhook only triggers when this column's value is truthy for a record.

Observable output

dataRequired
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulRequiredboolean
Whether or not the action execution was successful or not

Setup and approval

API key connection. Risk level 2 of 5.

Pricing and limits

Free Action

Unified payment: Not currently supported

Skills that use this Action

No published Skills explicitly reference this Action yet.

Official source

Provider source