The following object is returned upon a successful call:

WebhookConfiguration

Property	Type	Description
id	string	The API Space's unique identifier
name	string	The name of the webhook configuration
url	string	The target url of the webhook configuration
secret	string	The secret of the webhook configuration
subscriptions	WebhookSubscription[]	A list of event subscriptions this webhook forwards
createdOn	DateTime	The date (in UTC, ISO 8601 format) that the webhook was created
createdBy	string	The identity that created the webhook
updatedOn	DateTime	The date (in UTC, ISO 8601 format) that the webhook was last updated
updatedBy	string	The identity that created the webhook

WebhookSubscription

Property

Type

Description

type

string

The event type

filters

WebhookEventFilter[]

An array of filters used to filter the event so only events that pass the filters are forwarded.

No filters will forward all events

Property	Type	Description
name	string	Name of the filter
value	string	The value to watch for