Returns all configured webhooks.
Returns all configured webhooks of the workspace.
Required Permissions
The user must be an admin or haveworkspace-manage-config:read
permissions.Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
page
Page number for pagination
pageSize
Number of items per page
orderby
The properties to order by
filterby
The filter expression to filter by
Response
OK
name
The name of this webhook event.
uri
The URI to call.
events
The event(s) that trigger the web hook. A comma-separated list of events that trigger the webhook. The allowed events depend on the webhook type. For type ‘custom’: retrieve the list of allowed events from ‘/webhooks/eventTypes’ For type ‘slack’: retrieve the list of allowed events from ‘/webhooks/eventTypes/slack’
isActive
Whether the web hook is currently active.
authenticationType
The authentication type to use when calling the URI.
Can be 'none', 'header'.
language
The language of the web hook message that will be sent to the receiver.
Not required for custom web hooks.
onlyTriggerForMainEntityChanges
Whether to only send events for main entity changes and not for nested entities if the webhook is for a model.
authentication
The authentication value to use when calling the URI. Should be ‘key=value’. In case of header authentication, this should be ‘headername=headervalue’. Only required when the AuthenticationType is anything other than ‘none’.
id
The id of the webhook config.
receiverType
The type of the web hook.
Can be 'custom', 'slack'.
lastFailureReason
The most recent failure reason.
createdOn
The date this webhook config was created.
createdBy
The id of the user who created this webhook config.
updatedOn
The date this webhook config was last modified.
updatedBy
The id of the user who last modified this webhook config.