Grist Octri Preview
PATCH/docs/{docId}/webhooks/{webhookId}

Update a document webhook

Updates the configuration of an existing webhook, such as its URL, enabled state, or event types. Supply only the configuration fields you want to change; url, when provided, must use URI format.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 7 body fields
docIdstringrequired
The UUID of the document containing the webhook.
webhookIdstringrequired
The identifier of the webhook to update.

Webhook configuration fields to update.

enabledbooleanoptional
Whether the webhook is enabled.
eventTypesarray<string>optional
Array of event type names that trigger the webhook.
isReadyColumnstringoptional
The column used to determine whether a row is ready for webhook delivery.
memostringoptional
A memo associated with the webhook.
namestringoptional
The webhook name.
tableIdstringoptional
The identifier of the table associated with the webhook.
urlstringoptional
The webhook destination URL, in URI format.

1 status code
200Confirms that the webhook was updated. The response body is empty.

Error handling

The docId path parameter must identify the document, and the webhookId path parameter must identify an existing webhook. If provided, url must be a valid URI; eventTypes must be an array of strings.