Web Hooks can be used to get notified about content publishing events.

The configuration is set as a custom property on the Publication which is then valid for all contents inside this publication.

The value of the custom property is a configuration JSON like

No retry when the webhook endpoint is temporarily unavailable (i.e. due to a network error).

Learn how to use Web Hooks to receive notifications for content publishing events on your website. Explore the configuration options for filtering notifications and customizing the URL, headers, and parameters for the notification call. 

Subscription-API

Web Hooks

Hub Import API

Purple Editorial

Editorial

Purple Editorial Overview

Editor Overview

Article creation

Assets and images

Embeds and links

Creating Content

Publishing content

Content Binders

Curator

Planning and Workflows

Social Media Publishing (Nelio) in Purple Hub

Purple Redirects

Managing Content

Editor docs

Purple Editorial Concept

Admin Overview

Purple Blocks

Set up 'Background publishing'

Set up a custom domain for article preview in Purple Hub

Autosave frequency in Purple Hub

Configure TTS Blocks in the Purple Hub

Preview settings for Paywall content

Define the size for the Cropping Feature

Editorial Admin Set-up

Activate the new post overview UI in Purple Hub

Setting up the new post overview in Purple Hub

Hub Appearance

Create a taxonomy in Hub

Menus in Purple Hub

Configure Purple Variants

Create a Custom Post Type in Purple Hub

Customize the Block-menu for articles in Purple Hub

Create a block pattern and use it in an article in Purple Hub

Create a reusable block and add it to an article in Purple Hub

Create a custom block in Purple Hub

Create Custom Fields in Purple Hub

Configure ACFs to filter in the post overview

Blocks and fields

Enable Special Characters in Purple Hub

Configure quote style in Purple Hub

Character Limits in Purple Hub

Character Handling

Use machine translations of article contents with DeepL

Set up machine translations

Multi langugage

Purple RSS

Purple Wires: Generic Settings

Purple Wires: Article overview page

Purple Wires: Source overview page

Purple Wires: Source set up page

Purple Wires: Conditional imports

Purple Wires: Known issues

Purple Wires

Connect PPI CX Fusion (fka Tohoop) with Purple Hub

Connect Desk-Net to your Purple Hub

3rd party integrations

Admin

Developer Overview

Catalog-API

Receipt Events

Generic entitlement interface

Standard Entitlement Interface

Entitlement services

Custom S3 Buckets

Developer

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.

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.

Field	Type	Notes
key	String	Key of the custom property
value	String	Value of the custom property

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.

Web Hooks

Configuration

WebHook Configuration

ContentFilter

Property

NotificationConfig

Limitations