List webhook subscriptions

get /api/webhook_subscriptions

Retrieves the collection of WebhookSubscription resources.

Returns a paginated collection of the webhook subscriptions of the current tenant. Filter by id[]. Requires the webhooks:read scope. This endpoint is only available in the unstable version.

Query parameters

Name	Type	Required	Description
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}
id[]	string[]	-	Only the items with one of these ids, each a UUID or the item IRI.

Response

200 - WebhookSubscription collection

Property	Type	Required	Description
search	object	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string | null - last string | null - next string | null - previous string | null -
member	WebhookSubscription[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required callbackUrl string | null - The HTTPS endpoint notified when the topic fires. createdAt string - id string - includeFields array | null - Dot-path field selection limiting the delivered payload. Null or empty means the full payload. A * segment is a wildcard (e.g. *.id); the resource id is always included. topic string | null - The event topic to subscribe to. updatedAt string - version string | null - The pinned payload API version, or null when dynamic.

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-