Web Hooks
Web Hooks can be used to get notified about content publishing events
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
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
Variables need to be wrapped in {{}} as seen in the example to be recognized as placeholders. |
- No retry when the webhook endpoint is temporarily unavailable (i.e. due to a network error).