# Bitbucket Webhooks API

**Canonical:** https://apis.io/apis/bitbucket/bitbucket-webhooks-api/  
**Provider:** Bitbucket — https://apis.io/providers/bitbucket/  
**Base URL:** https://api.bitbucket.org/2.0  
**Documentation:** https://developer.atlassian.com/bitbucket/api/2/reference/

Bitbucket Webhooks API is one of 23 APIs that [Bitbucket](https://apis.io/providers/bitbucket/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 8 JSON Schema definitions. Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 8 JSON Schemas.

Webhooks provide a way to configure Bitbucket Cloud to make requests to your server (or another external service) whenever certain events occur in Bitbucket Cloud. A webhook consists of: * A subject -- The resource that generates the events. Currently, this resource is the repository, user account, or team where you create the webhook. * One or more event -- The default event is a repository push, but you can select multiple events that can trigger the webhook. * A URL -- The endpoint where you want Bitbucket to send the event payloads when a matching event happens. There are two parts to getting a webhook to work: creating the webhook and triggering the webhook. After you create a webhook for an event, every time that event occurs, Bitbucket sends a payload request that describes the event to the specified URL. Thus, you can think of webhooks as a kind of notification system. Use webhooks to integrate applications with Bitbucket Cloud. The following use cases provides examples of when you would want to use webhooks: * Every time a user pushes commits in a repository, you may want to notify your CI server to start a build. * Every time a user pushes commits or creates a pull request, you may want to display a notification in your application.

## Machine-readable artifacts (16)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/openapi/bitbucket-webhooks-api-openapi.yml
- **Documentation** — https://developer.atlassian.com/bitbucket/api/2/reference/
- **Authentication** — https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-repository-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-pullrequest-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-pipeline-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-commit-schema.json
- **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-repository-structure.json
- **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-pullrequest-structure.json
- **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-pipeline-structure.json
- **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-commit-structure.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-repository-example.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-pullrequest-example.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-pipeline-example.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-commit-example.json
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/asyncapi/bitbucket-cloud-webhooks-asyncapi.yml

## Other Bitbucket APIs (12)

- [Bitbucket Addon API](https://apis.io/apis/bitbucket/bitbucket-addon-api/)
- [Bitbucket Branch restrictions API](https://apis.io/apis/bitbucket/bitbucket-branch-restrictions-api/)
- [Bitbucket Branching model API](https://apis.io/apis/bitbucket/bitbucket-branching-model-api/)
- [Bitbucket Commit statuses API](https://apis.io/apis/bitbucket/bitbucket-commit-statuses-api/)
- [Bitbucket Commits API](https://apis.io/apis/bitbucket/bitbucket-commits-api/)
- [Bitbucket Deployments API](https://apis.io/apis/bitbucket/bitbucket-deployments-api/)
- [Bitbucket Downloads API](https://apis.io/apis/bitbucket/bitbucket-downloads-api/)
- [Bitbucket GPG API](https://apis.io/apis/bitbucket/bitbucket-gpg-api/)
- [Bitbucket Issue tracker API](https://apis.io/apis/bitbucket/bitbucket-issue-tracker-api/)
- [Bitbucket Pipelines API](https://apis.io/apis/bitbucket/bitbucket-pipelines-api/)
- [Bitbucket Projects API](https://apis.io/apis/bitbucket/bitbucket-projects-api/)
- [Bitbucket properties API](https://apis.io/apis/bitbucket/bitbucket-properties-api/)

## Tags

Webhook

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bitbucket/bitbucket-webhooks-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bitbucket/.