# Bitbucket Pipelines Webhooks API

**Canonical:** https://apis.io/apis/bitbucket-pipelines/bitbucket-pipelines-webhooks-api/  
**Provider:** Bitbucket Pipelines — https://apis.io/providers/bitbucket-pipelines/  
**Base URL:** https://api.bitbucket.org/2.0  
**Documentation:** https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/

Bitbucket Pipelines Webhooks API is one of 23 APIs that [Bitbucket Pipelines](https://apis.io/providers/bitbucket-pipelines/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

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 (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bitbucket-pipelines/refs/heads/main/openapi/bitbucket-pipelines-webhooks-api-openapi.yml
- **Documentation** — https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pipelines/
- **APIReference** — https://developer.atlassian.com/cloud/bitbucket/rest/intro/
- **OpenAPISource** — https://api.bitbucket.org/swagger.json
- **Authentication** — https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication

## Other Bitbucket Pipelines APIs (12)

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

## Tags

Webhook

---

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