Sorry, no results found for "".

Show examples in:

Javascript HTTP

Endpoint info

Body parameters

Returns

Available examples

Basic example

Content Management API > Webhook

Create a new webhook

Body parameters

name string Required

Unique name for the webhook

Example:

"Item type creation/update"

url string Required

The URL to be called

Example:

"https://www.example.com/webhook"

headers object Required

Additional headers that will be sent

Example:

{ "X-Foo": "Bar" }

events Required

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>

custom_payload string, null Required

A custom payload

Example:

'{ "message": "{{event_type}} event triggered on {{entity_type}}!", "entity_id": "{{#entity}}{{id}}{{/entity}}"] }'

http_basic_user string, null Required

HTTP Basic Authorization username

Example:

"user"

http_basic_password string, null Required

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

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const webhook = await client.webhooks.create({
7
    name: "Item type creation/update",
8
    url: "https://www.example.com/webhook",
9
    headers: { "X-Foo": "Bar" },
10
    events: [{ entity_type: "item", event_types: ["update"] }],
11
    custom_payload:
12
      '{ "message": "{{event_type}} event triggered on {{entity_type}}!", "entity_id": "{{#entity}}{{id}}{{/entity}}"] }',
13
    http_basic_user: "user",
14
    http_basic_password: "password",
15
  });
16

17
  // Check the 'Returned output' tab for the result ☝️
18
  console.log(webhook);
19
}
20

21
run();

1
{
2
  id: "312",
3
  name: "Item type creation/update",
4
  url: "https://www.example.com/webhook",
5
  enabled: true,
6
  headers: { "X-Foo": "Bar" },
7
  events: [{ entity_type: "item", event_types: ["update"] }],
8
  http_basic_user: "user",
9
  http_basic_password: "password",
10
  custom_payload: '{ "message": "{{event_type}} event triggered on {{entity_type}}!", "entity_id": "{{#entity}}{{id}}{{/entity}}"] }',
11
  payload_api_version: "3",
12
  nested_items_in_payload: true,
13
  auto_retry: true,
14
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.