How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian Webhooks API

The Webhooks API from Atlassian — 9 operation(s) for webhooks.

Atlassian Webhooks API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 7 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.bitbucket.org/2.0, https://your-domain.atlassian.net.

7 operations 5 paths 15 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.bitbucket.org/2.0
https://your-domain.atlassian.net
Authentication
HTTP Basic, OAuth 2.0, API Key, OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 5

Atlassian Webhooks API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 24 scopes. An API key is passed in the header as Authorization (api_key). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • 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…
  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhooks 7

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…

GET
/hook_events
Atlassian Get A Webhook Resource
atlassianGetAWebhookResource → 200
GET
/hook_events/{subject_type}
Atlassian List Subscribable Webhook Types
atlassianListSubscribableWebhookTypes 1 param → 200404
DELETE
/rest/api/3/webhook
Atlassian Delete Webhooks By Id
atlassianDeletewebhookbyid body → 202400403
GET
/rest/api/3/webhook
Atlassian Get Dynamic Webhooks For App
atlassianGetdynamicwebhooksforapp 2 params → 200400403
POST
/rest/api/3/webhook
Atlassian Register Dynamic Webhooks
atlassianRegisterdynamicwebhooks body → 200400403
GET
/rest/api/3/webhook/failed
Atlassian Get Failed Webhooks
atlassianGetfailedwebhooks 2 params → 200400403
PUT
/rest/api/3/webhook/refresh
Atlassian Extend Webhook Life
atlassianRefreshwebhooks body → 200400403

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PageBeanWebhook (7 properties), Webhook (6 properties), paginated_hook_events (6 properties), FailedWebhook (4 properties). Each schema is shown below with its type and property counts.

hook_event
object
An event, associated with a resource or subject type.
4 properties
subject_types
object
The mapping of resource/subject types pointing to their individual event types.
2 properties
error
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
2 properties 1 required
paginated_hook_events
object
A paginated list of webhook types available to subscribe on.
6 properties
Webhook
object
A webhook.
6 properties 3 required
ContainerForWebhookIDs
object
Container for a list of webhook IDs.
1 property 1 required
WebhookRegistrationDetails
object
Details of webhooks to register.
2 properties 2 required
WebhookDetails
object
A list of webhooks.
4 properties 2 required
WebhooksExpirationDate
object
The date the refreshed webhooks expire.
1 property 1 required
ContainerForRegisteredWebhooks
object
Container for a list of registered webhooks. Webhook details are returned in the same order as the request.
1 property
ErrorCollection
object
Error messages from an operation.
3 properties
FailedWebhooks
object
A page of failed webhooks.
3 properties 2 required
RegisteredWebhook
object
ID of a registered webhook or error messages explaining why a webhook wasn't registered.
2 properties
FailedWebhook
object
Details about a failed webhook.
4 properties 3 required
PageBeanWebhook
object
A page of items.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-webhooks-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian 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.