|format||yes||Whether it is posted as JSON (|
|id||no||A unique ID for the Webhook assigned by the system|
|object||yes||Whether the returned object is |
Whether to post data as JSON or XML.
The object type determines the amount of details returned by the <webevent> element.
|Include private and public identifiers only (for example |
|Include optional data.|
Whether you choose one or the other depends on the requirements of your system.
minimal when being able to identify updated or deleted objects is sufficient and the objects are retrieved when needed with additional requests. For example, to maintain a cache. The business logic using minimal is often simpler to maintain and it is more efficient for PageSeeder.
basic when you need additional details when you are notified of the update, while this might save you from making additional requests, this might put more strain on the server and usually involve a more complicated business logic on the client side.
Delete events always return the minimal object.
It is one of the following values based on the last time is was used. If it is not active, check the troubleshooting section of the web hooks guide.
|active||Ready to receive event POST requests|
|disabled||Manually stopped from receiving events|
|error||Other fatal error|
|pending||Awaiting confirmation of ping request|
|unreachable||Has reached the maximum number of retries for failed POST requests|
|warning||Has failed POST requests that are still being retried|
If the status is
unreachable, some events might have been lost.