Show examples in:
Javascript HTTP
Endpoint info
Available examples

Content Management API > Webhook

List all webhooks

Returns

Returns an array of resource objects of type webhook.

Examples

1
GET https://site-api.datocms.com/webhooks HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
Terminal window
1
curl -g 'https://site-api.datocms.com/webhooks' \
2
\
3
-H "Authorization: Bearer YOUR-API-TOKEN" \
4
-H "Accept: application/json" \
5
-H "X-Api-Version: 3"
1
await fetch("https://site-api.datocms.com/webhooks", {
2
headers: {
3
Authorization: "Bearer YOUR-API-TOKEN",
4
Accept: "application/json",
5
"X-Api-Version": "3",
6
},
7
});
1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6
7
{
8
"data": [
9
{
10
"type": "webhook",
11
"id": "312",
12
"attributes": {
13
"name": "Item type creation/update",
14
"url": "https://www.example.com/webhook",
15
"enabled": true,
16
"headers": {
17
"X-Foo": "Bar"
18
},
19
"events": [
20
{
21
"entity_type": "item",
22
"event_types": [
23
"update"
24
]
25
}
26
],
27
"http_basic_user": "user",
28
"http_basic_password": "password",
29
"custom_payload": "{ \"message\": \"{{event_type}} event triggered on {{entity_type}}!\", \"entity_id\": \"{{#entity}}{{id}}{{/entity}}\"] }",
30
"payload_api_version": "3",
31
"nested_items_in_payload": true,
32
"auto_retry": true
33
}
34
}
35
]
36
}