Content Management API > Webhook
Update a webhook
Body parameters
name string Optional
Unique name for the webhook
Example:
"Item type creation/update"
url string Optional
The URL to be called
Example:
"https://www.example.com/webhook"
custom_payload string, null Optional
A custom payload
Example:
'{ "message": "{{event_type}} event triggered on {{entity_type}}!", "entity_id": "{{#entity}}{{id}}{{/entity}}"] }'
headers object Optional
Additional headers that will be sent
Example:
{ "X-Foo": "Bar" }
events Optional
Type:
Array<object>
entity_type enum Required
The subject of webhook triggering
Example:
"item"
item_type Optional
item Optional
upload Optional
build_trigger Optional
environment Optional
maintenance_mode Optional
sso_user Optional
cda_cache_tags Optional
event_types Required
Type:
Array<string>
filters Optional
Type:
Array<object>, null
entity_type enum Required
item_type Optional
item Optional
build_trigger Optional
environment Optional
environment_type Optional
entity_ids Required
Type:
Array<string>
http_basic_user string, null Optional
HTTP Basic Authorization username
Example:
"user"
http_basic_password string, null Optional
HTTP Basic Authorization password
Example:
"password"
enabled boolean Optional
Whether the webhook is enabled and sending events or not
payload_api_version string Optional
Specifies which API version to use when serializing entities in the webhook payload
Example:
"3"
nested_items_in_payload boolean Optional
Whether the you want records present in the payload to show blocks expanded or not
auto_retry boolean Optional
If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
Returns
Returns a resource object of type webhook
Examples
import { buildClient } from "@datocms/cma-client-node";
async function run() { const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
const webhookId = "312";
const webhook = await client.webhooks.update(webhookId, { id: "312" });
// Check the 'Returned output' tab for the result ☝️ console.log(webhook);}
run();{ id: "312", name: "Item type creation/update", url: "https://www.example.com/webhook", enabled: true, headers: { "X-Foo": "Bar" }, events: [{ entity_type: "item", event_types: ["update"] }], http_basic_user: "user", http_basic_password: "password", custom_payload: '{ "message": "{{event_type}} event triggered on {{entity_type}}!", "entity_id": "{{#entity}}{{id}}{{/entity}}"] }', payload_api_version: "3", nested_items_in_payload: true, auto_retry: true,}