Show examples in:
Webhook call

Represents a log entry in the webhooks activity list.

Object payload

id  string
ID of webhook call
type  string
Must be exactly "webhook_call"
entity_type  enum  Example: "item"

The subject of webhook triggering

event_type  enum  Example: "update"

The event that triggers the webhook call

created_at  date-time  Example: "2016-09-20T18:50:24.914Z"

The moment the call occurred

request_url  string  Example: "https://www.example.com/webhook"

The url that the webhook called

request_headers  object  Example: {"Accept":"*/*","User-Agent":"DatoCMS (datocms.com)","Authorization":"Basic Y2lhbzptaWFv","Content-Type":"application/json"}

The request's headers

request_payload  string  Example: "{\"environment\":\"main\",\"entity_type\":\"item\",\"event_type\":\"create\",\"entity\":{\"id\":\"Ke9nrZ4iRHWpKbJplG_zdQ\",\"type\":\"item\",\"attributes\":{\"text_field\":\"Test\"},\"relationships\":{\"item_type\":{\"data\":{\"id\":\"Dq4WEbdjStWIeSeH_lBA-Q\",\"type\":\"item_type\"}},\"creator\":{\"data\":{\"id\":\"104280\",\"type\":\"account\"}}},\"meta\":{\"created_at\":\"2024-04-03T22:47:43.488+01:00\",\"updated_at\":\"2024-04-03T22:47:43.496+01:00\",\"published_at\":\"2024-04-03T22:47:43.532+01:00\",\"publication_scheduled_at\":null,\"unpublishing_scheduled_at\":null,\"first_published_at\":\"2024-04-03T22:47:43.532+01:00\",\"is_valid\":true,\"is_current_version_valid\":true,\"is_published_version_valid\":true,\"status\":\"published\",\"current_version\":\"QXuPXVc6SDmXcDh1MnImHQ\",\"stage\":null}},\"related_entities\":[{\"id\":\"Dq4WEbdjStWIeSeH_lBA-Q\",\"type\":\"item_type\",\"attributes\":{\"name\":\"ExampleModel\",\"singleton\":true,\"sortable\":false,\"api_key\":\"example_model\",\"ordering_direction\":null,\"ordering_meta\":null,\"tree\":false,\"modular_block\":false,\"draft_mode_active\":false,\"all_locales_required\":false,\"collection_appearance\":\"table\",\"has_singleton_item\":true,\"hint\":null,\"inverse_relationships_enabled\":false},\"relationships\":{\"fields\":{\"data\":[{\"id\":\"TuzswqxpQXyzJGv_3JtBAA\",\"type\":\"field\"}]},\"fieldsets\":{\"data\":[]},\"singleton_item\":{\"data\":{\"id\":\"Ke9nrZ4iRHWpKbJplG_zdQ\",\"type\":\"item\"}},\"ordering_field\":{\"data\":null},\"title_field\":{\"data\":{\"id\":\"TuzswqxpQXyzJGv_3JtBAA\",\"type\":\"field\"}},\"image_preview_field\":{\"data\":null},\"excerpt_field\":{\"data\":null},\"workflow\":{\"data\":null}},\"meta\":{\"has_singleton_item\":true}}]}"

The webhook's request payload is encoded as a string. Use JSON.parse() to parse it.

response_status  integer, null  Example: 200

The status of the response

response_headers  object  Example: {"via":"1.1 vegur, 1.1 37c0945d19329fccc23efb283d01aa06.cloudfront.net (CloudFront)","date":"Fri, 27 Jul 2018 11:59:20 GMT","server":"gunicorn/19.6.0"}

The response's headers

response_payload  string, null  Example: "ok"

The body of the response

webhook{ type: "webhook", id: webhook.id }

The webhook which has been called

Available endpoints