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:
"created_at_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
GET https://site-api.datocms.com/webhook_calls HTTP/1.1Authorization: Bearer YOUR-API-TOKENAccept: application/jsonX-Api-Version: 3curl -g 'https://site-api.datocms.com/webhook_calls' \ \ -H "Authorization: Bearer YOUR-API-TOKEN" \ -H "Accept: application/json" \ -H "X-Api-Version: 3"await fetch("https://site-api.datocms.com/webhook_calls", { headers: { Authorization: "Bearer YOUR-API-TOKEN", Accept: "application/json", "X-Api-Version": "3", },});HTTP/1.1 200 OKContent-Type: application/jsonCache-Control: cache-control: max-age=0, private, must-revalidateX-RateLimit-Limit: 30X-RateLimit-Remaining: 28
{ "data": [ { "type": "webhook_call", "id": "42", "attributes": { "entity_type": "item", "event_type": "update", "created_at": "2016-09-20T18:50:24.914Z", "request_url": "https://www.example.com/webhook", "request_headers": { "Accept": "*/*", "User-Agent": "DatoCMS (datocms.com)", "Authorization": "Basic Y2lhbzptaWFv", "Content-Type": "application/json" }, "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\":[]}", "response_status": 200, "response_headers": { "via": "1.1 vegur, 1.1 37c0945d19329fccc23efb283d01aa06.cloudfront.net (CloudFront)", "date": "Fri, 27 Jul 2018 11:59:20 GMT", "server": "gunicorn/19.6.0" }, "response_payload": "ok", "attempted_auto_retries_count": 2, "last_sent_at": "2016-09-20T18:50:24.914Z", "next_retry_at": "2016-09-20T18:50:24.914Z", "status": "success" }, "relationships": { "webhook": { "data": { "type": "webhook", "id": "312" } } } } ], "included": [ { "type": "webhook", "id": "312", "attributes": { "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 } } ], "meta": { "total_count": 20 }}