ATatlassian
Workspaces
Webhooks

Update a webhook for a workspace

Changed on

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/workspaces/{workspace}/hooks/{uid}

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/workspaces/{workspace}/hooks/{uid}
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: webhook
    • or HTTP basic
    • or API key in header Authorization

Path parameters

workspacestring required

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

uidstring required

The webhook's id.

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

Whether or not the webhook subscription is enabled.

created_atstring date-time

The timestamp when the webhook subscription was created.

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.

Changes

  • 869214428f35Revision changes
    • breaking

      added the new path request parameter uid

    • breaking

      added the new path request parameter workspace

    • info

      api operation id update_workspace_hook was added

    • info

      added the optional property / to the response with the status

    • info

      the response optional property / became read-only for the status

    • info

      the response optional property / became read-only for the status

    • info

      the response optional property / became read-only for the status

    • info

      the response optional property / became read-only for the status

  • d344164ecb11Revision changes
    • warning

      added the new pipeline:span_created enum value to the // response property for the response status

    • warning

      added the new pullrequest:push enum value to the // response property for the response status