Sign in
latestOpenAPI 3.0.02026-08-232971951.3 MB

3dbfe6a80143

Workspaces
Webhooks

Get a webhook for a workspace

Returns the webhook with the specified id installed on the given workspace.

get/workspaces/{workspace}/hooks/{uid}

Response

The webhook subscription object.

typestring required
uuidstring

The webhook's id

urlstring uri

The URL events get delivered to.

descriptionstring

A user-defined description of the webhook.

subject_type'repository' | 'workspace'

The type of entity. Set to either repository or workspace based on where the subscription is defined.

activeboolean
created_atstring date-time
eventsstring[]

The events this webhook is subscribed to.

secret_setboolean

Indicates whether or not the hook has an associated secret. It is not possible to see the hook's secret. This field is ignored during updates.

secretstring

The secret to associate with the hook. The secret is never returned via the API. As such, this field is only used during updates. The secret can be set to null or "" to remove the secret (or create a hook with no secret). Leaving out the secret field during updates will leave the secret unchanged. Leaving out the secret during creation will create a hook with no secret.