Skip to main content

 Element reference

Service API elements from <alias> to <workflow>

<webhook>

Summary

Usage context

Permitted content<client>
Permitted parent<webhooks>

Attributes

NameTypeRequiredDescription
activatesecretxs:stringno
createdxs:datetimeyes
eventsenumno
formatenumyesWhether it is posted as JSON (json) or XML (xml)
groupsno
idXS:longnoA unique ID for the Webhook assigned by the system
insecuresslyes
modifiedxs:datetimeyes
namexs:stringno
objectenumyesWhether the returned object is minimal or basic 
projectsno
serverboolean yes
statusenumyes
urlurlyes

@format

Whether to post data as JSON or XML.

@object

The object type determines the amount of details returned by the <webevent> element.

Object typeDescription
minimal Include private and public identifiers only (for example id and name attributes).
basic Include optional data.

Whether you choose one or the other depends on the requirements of your system.

Use 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.

Use 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.

@status 

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.

StatusDescription
activeReady to receive event POST requests
disabledManually stopped from receiving events
errorOther fatal error
pendingAwaiting confirmation of ping request
unreachableHas reached the maximum number of retries for failed POST requests
warningHas failed POST requests that are still being retried

If the status is error or unreachable, some events might have been lost.

Examples

Schema

Compatibility

Created on , last edited on