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:
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:
Returns the webhook resource or subject types on which webhooks can be registered.
Each resource/subject type contains an events
link that returns the
paginated list of specific events each individual subject type can
emit.
This endpoint is publicly accessible and does not require authentication or scopes.
This request has no parameters.
A mapping of resource/subject types pointing to their individual event types.
The mapping of resource/subject types pointing to their individual event types.
1
2
3
4
curl --request GET \
--url 'https://api.bitbucket.org/2.0/hook_events' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"repository": {
"links": {
"events": {
"href": "https://api.bitbucket.org/2.0/hook_events/repository"
}
}
},
"workspace": {
"links": {
"events": {
"href": "https://api.bitbucket.org/2.0/hook_events/workspace"
}
}
}
}
Returns a paginated list of all valid webhook events for the specified entity. The team and user webhooks are deprecated, and you should use workspace instead. For more information, see the announcement.
This is public data that does not require any scopes or authentication.
NOTE: The example response is a truncated response object for the workspace
subject_type
.
We return the same structure for the other subject_type
objects.
string
RequiredA paginated list of webhook types available to subscribe on.
A paginated list of webhook types available to subscribe on.
1
2
3
4
curl --request GET \
--url 'https://api.bitbucket.org/2.0/hook_events/{subject_type}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
"page": 1,
"pagelen": 30,
"size": 4,
"values": [
{
"category": "Repository",
"description": "Whenever a repository push occurs",
"event": "repo:push",
"label": "Push"
},
{
"category": "Repository",
"description": "Whenever a repository fork occurs",
"event": "repo:fork",
"label": "Fork"
},
{
"category": "Repository",
"description": "Whenever a repository import occurs",
"event": "repo:imported",
"label": "Import"
},
{
"category": "Pull Request",
"label": "Approved",
"description": "When someone has approved a pull request",
"event": "pullrequest:approved"
}
]
}
Rate this page: