Bitbucket Pipelines Webhooks API
Webhooks provide a way to configure Bitbucket Cloud to make requests toyour server (or another external service) whenever certain events occur inBitbucket Cloud.A webhook consists of:* A subject -- The resource that generates the events. Currently, this resourceis the repository, user account, or team where you create the webhook.* One or more event -- The default event is a repository push, but you canselect multiple events that can trigger the webhook.* A URL -- The endpoint where you want Bitbucket to send the event payloadswhen a matching event happens.There are two parts to getting a webhook to work: creating the webhook andtriggering the webhook. After you create a webhook for an event, every timethat event occurs, Bitbucket sends a payload request that describes the eventto the specified URL. Thus, you can think of webhooks as a kind ofnotification system.Use webhooks to integrate applications with Bitbucket Cloud. The followinguse cases provides examples of when you would want to use webhooks:* Every time a user pushes commits in a repository, you may want to notifyyour CI server to start a build.* Every time a user pushes commits or creates a pull request, you may want todisplay a notification in your application.
Bitbucket Pipelines Webhooks API is one of 23 APIs that Bitbucket Pipelines publishes on the 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.
This API exposes 12 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 2.0, at version 2.0.
Requests are made against the base URL https://api.bitbucket.org/2.0.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Bitbucket Pipelines Webhooks API declares
3 security schemes
for authenticating requests.
It defines a basic scheme (basic).
It supports OAuth 2.0 (oauth2) using the accessCode flow, exposing 26 scopes.
An API key is passed in the header as Authorization (api_key).
basic— Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username a…oauth2— OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).api_key— API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only availa…
Paths & Operations 12
Across 6 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
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 consi…
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are paginated_webhook_subscriptions (6 properties), paginated_hook_events (6 properties), hook_event (4 properties), error (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bitbucket Pipelines 12
Other APIs Bitbucket Pipelines publishes across the network.
This is an independent, third-party profile of Bitbucket Pipelines Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.