Show examples in:

Endpoint info

Returns

Available examples

List all calls

Content Management API > Webhook call

List all webhooks calls

Query parameters

page object

Parameters to control offset-based pagination

offset integer

The (zero-based) offset of the first entity returned in the collection (defaults to 0)

limit integer

The maximum number of entities to return (defaults to 30, maximum is 500)

filter object

Attributes to filter

ids string

IDs to fetch, comma separated

Example:

"42,554"

fields object

webhook_id object

eq string

entity_type object

eq enum

The subject of webhook triggering

Example:

"item"

item_type

item

upload

build_trigger

environment

maintenance_mode

sso_user

cda_cache_tags

event_type object

eq enum

The event that triggers the webhook call

Example:

"update"

create

update

delete

publish

unpublish

promote

deploy_started

deploy_succeeded

deploy_failed

change

invalidate

status object

eq enum

The current status

Example:

"success"

pending

The delivery attempt is currently in process

success

Delivery completed successfully

failed

Delivery attempt(s) failed due to errors/timeouts

rescheduled

The last delivery attempt failed, a new one will be retried later

last_sent_at object

gt date-time

lt date-time

next_retry_at object

gt date-time

lt date-time

created_at object

gt date-time

lt date-time

order_by enum

Fields used to order results

Example:

"name_DESC"

webhook_id_asc

webhook_id_desc

created_at_asc

created_at_desc

last_sent_at_asc

last_sent_at_desc

next_retry_at_asc

next_retry_at_desc

Returns

Returns an array of resource objects of type webhook_call.

Other examples

1
GET https://site-api.datocms.com/webhook_calls HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3

1
curl -g 'https://site-api.datocms.com/webhook_calls' \
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/webhook_calls", {
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_call",
11
      "id": "42",
12
      "attributes": {
13
        "entity_type": "item",
14
        "event_type": "update",
15
        "created_at": "2016-09-20T18:50:24.914Z",
16
        "request_url": "https://www.example.com/webhook",
17
        "request_headers": {
18
          "Accept": "*/*",
19
          "User-Agent": "DatoCMS (datocms.com)",
20
          "Authorization": "Basic Y2lhbzptaWFv",
21
          "Content-Type": "application/json"
22
        },
23
        "request_payload": "{\"webhook_call_id\":\"103216210\",\"event_triggered_at\":\"2024-08-26T12:49:16Z\",\"attempted_auto_retries_count\":0,\"webhook_id\":\"28374\",\"site_id\":\"205\",\"environment\":\"main\",\"is_environment_primary\":true,\"entity_type\":\"maintenance_mode\",\"event_type\":\"change\",\"entity\":{\"id\":\"maintenance_mode\",\"type\":\"maintenance_mode\",\"attributes\":{\"active\":false}},\"related_entities\":[]}",
24
        "response_status": 200,
25
        "response_headers": {
26
          "via": "1.1 vegur, 1.1 37c0945d19329fccc23efb283d01aa06.cloudfront.net (CloudFront)",
27
          "date": "Fri, 27 Jul 2018 11:59:20 GMT",
28
          "server": "gunicorn/19.6.0"
29
        },
30
        "response_payload": "ok",
31
        "attempted_auto_retries_count": 2,
32
        "last_sent_at": "2016-09-20T18:50:24.914Z",
33
        "next_retry_at": "2016-09-20T18:50:24.914Z",
34
        "status": "success"
35
      },
36
      "relationships": {
37
        "webhook": {
38
          "data": {
39
            "type": "webhook",
40
            "id": "312"
41
          }
42
        }
43
      }
44
    }
45
  ],
46
  "included": [
47
    {
48
      "type": "webhook",
49
      "id": "312",
50
      "attributes": {
51
        "name": "Item type creation/update",
52
        "url": "https://www.example.com/webhook",
53
        "enabled": true,
54
        "headers": {
55
          "X-Foo": "Bar"
56
        },
57
        "events": [
58
          {
59
            "entity_type": "item",
60
            "event_types": [
61
              "update"
62
            ]
63
          }
64
        ],
65
        "http_basic_user": "user",
66
        "http_basic_password": "password",
67
        "custom_payload": "{ \"message\": \"{{event_type}} event triggered on {{entity_type}}!\", \"entity_id\": \"{{#entity}}{{id}}{{/entity}}\"] }",
68
        "payload_api_version": "3",
69
        "nested_items_in_payload": true,
70
        "auto_retry": true
71
      }
72
    }
73
  ],
74
  "meta": {
75
    "total_count": 20
76
  }
77
}

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.