Developer
Web Hooks
6min
web hooks can be used to get notified about content publishing events configuration the configuration is set as a custom property on the publication which is then valid for all contents inside this publication the custom property key be webhook config the value of the custom property is a configuration json like { "processonce" false, "filter" { "type" "post", "properties" \[ { "key" "print transfer", "value" "true" } ] }, "notification" { "url" "https //example com/event", "method" "post", "parameters" { "guid" "{{id}}", "preview" "{{preview}}" }, "headers" { "x api key" "123456" } } } webhook configuration field type default value notes processonce boolean true if true, a notification will be send only for the first matching content publish event any updates to the same content will not cause another notification to be send filter contentfilter with the filter element the notifications can be filtered by type and properties notification notificationconfig the notification element configures the notification call contentfilter field type notes type contenttype available values issue, post, bundle properties property match contents based on their custom properties all provided keys and values need to match exactly using string comparison property field type notes key string key of the custom property value string value of the custom property notificationconfig field type notes url string the endpoint to send the notification to method enum get, post headers map\<string, string> additional headers for the request, e g api keys or authorization header parameters map\<string, string> parameters are send as query parameters if the method is set to get when the method is set to post the parameters are send as json in the request body the parameter elements allow variables populated from the content supported values are id name posttype preview externalid property \<issue custom property key> variables need to be wrapped in {{}} as seen in the example to be recognized as placeholders limitations no retry when the webhook endpoint is temporarily unavailable (i e due to a network error)