Sign in

v2

latestOpenAPI 3.0.02026-08-013312111.4 MB
Repositories
Webhooks

Update a webhook for a repository

Updates the specified webhook subscription.

The following properties can be mutated:

  • description
  • url
  • secret
  • active
  • events

The hook's secret is used as a key to generate the HMAC hex digest sent in the X-Hub-Signature header at delivery time. This signature is only generated when the hook has a secret.

Set the hook's secret by passing the new value in the secret field. Passing a null value in the secret field will remove the secret from the hook. The hook's secret can be left unchanged by not passing the secret field in the request.

put/repositories/{workspace}/{repo_slug}/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.