Retrieves a webhook configuration

The following object is returned upon a successful call:

WebhookConfiguration

PropertyTypeDescription
idstringThe API Space's unique identifier
namestringThe name of the webhook configuration
urlstringThe target url of the webhook configuration
secretstringThe secret of the webhook configuration
subscriptionsWebhookSubscription[]A list of event subscriptions this webhook forwards
createdOnDateTimeThe date (in UTC, ISO 8601 format) that the webhook was created
createdBystringThe identity that created the webhook
updatedOnDateTimeThe date (in UTC, ISO 8601 format) that the webhook was last updated
updatedBystringThe identity that created the webhook

WebhookSubscription

PropertyTypeDescription
typestringThe event type
filtersWebhookEventFilter[]

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

No filters will forward all events

WebhookEventFilter

PropertyTypeDescription
namestringName of the filter
valuestringThe value to watch for
Path Params
string
required
^([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|[a-f0-9]{32}$

The api space id

string
required

The webhook id

Query Params
boolean

Indicates whether deleted conversations should be returned

Responses

404

The webhook configuration was not found

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json