Last updated Apr 8, 2024

Change notice - Removing webhooks registered via Connect apps from /2.0/.../hooks API response

On April 30, 2021 Bitbucket /2.0/.../hooks API for retrieving webhooks will no longer include the read-only hooks registered via Connect apps in the response. If you are using these API endpoints, please read on.

Which API endpoints are affected?

This change reduces the amount of data returned by the following endpoints:

The same also applies to the endpoints below, which are already deprecated. If you are still using these, switch to using the /workspaces endpoints:

What is changing?

Currently the GET responses from the above endpoints include 2 types of webhooks:

  1. Webhooks registered either via Repository Settings -> Webhooks page in Bitbucket Cloud UI, or via the /2.0/.../hooks API endpoints.
  2. Webhooks registered via a Connect app descriptor that are marked as read-only. These cannot be modified via the /2.0/.../hooks API.

This change will remove the read-only hooks in category 2 from webhooks API responses. The hooks in category 1 are not affected and will continue to be returned as they are today.

This change only affects the amount of data returned by webhooks API. There is no impact to the API schema. There is no impact to how you can register webhooks. There is also no impact to the actual triggering or delivery of webhooks.

What action do you need to take?

If you are only using these API endpoints to retrieve the webhooks you registered via Repository Settings on Bitbucket Cloud UI or via webhooks API, then you do not need to do anything.

If you actually need to retrieve information on the webhooks registered by Connect apps, then contact us at Atlassian Developer Community with your use case.

Rate this page: