Request structure

The structure of the request sent to the subscribers has two important sections:

General

The general section contains all basic data concerning the webhook. For example the event which triggered the execution of the webhook or if only the version (draft) was saved.

...
"general": {
    "eventName": "pimcore.dataobject.postUpdate",
    "timestamp": 1653303523,
    "subjectType": "object"
    "versionOnly": true
},
...

Subject

The subject section contains all information regarding the Data Object, Asset or Document based on the selected schema. It also includes the binary data, if selected, as a base64 encoded string.

...
"subject": {
    "id": 81,
    "name": "Cobra 427",
    "description": null,
    "gallery": null,
    "published": true    
    }
...

Samples

Data Objects

{
  "general": {
    "eventName": "pimcore.dataobject.postUpdate",
    "timestamp": 1690975273,
    "subjectType": "object",
    "versionOnly": false
  },
  "subject": {
    "id": 260,
    "path": "/Product Data/Cars/alfa romeo/1900",
    "Name (name)": "1900",
    "Description (description)": "<p>The Alfa Romeo 1900 is an automobile produced by Italian car manufacturer Alfa Romeo from 1950 to 1959. Designed by Orazio Satta, it was an important development for Alfa Romeo as the marque&#039;s first car built entirely on a production line and first production car without a separate chassis. It was also the first Alfa Romeo offered with left-hand drive. The car was introduced at the 1950 Paris Motor Show.</p>",
    "published": false,
    "type": "Car"
  }
}

Assets

{
  "general": {
    "eventName": "pimcore.asset.postUpdate",
    "timestamp": 1690975091,
    "subjectType": "asset",
    "versionOnly": false
  },
  "subject": {
    "id": 83,
    "path": "/Car Images/ferrari/061_-_Ferrari_Testarossa_-_Flickr_-_Price-Photography.jpg",
    "userModification": 25,
    "userModificationName": "admin",
    "type": "image",
    "mimeType": "image/jpeg"
  }
}

Documents

{
  "general": {
    "eventName": "pimcore.document.postUpdate",
    "timestamp": 1690975115,
    "subjectType": "document",
    "versionOnly": false
  },
  "subject": {
    "id": 65,
    "path": "/en/News",
    "userModification": 25,
    "userModificationName": "admin",
    "published": true,
    "type": "page"
  }
}