Create a webhook for a workspace
Changed onCreates a new webhook on the specified workspace.
Workspace webhooks are fired for events from all repositories contained by that workspace.
Example:
$ curl -X POST -u credentials -H 'Content-Type: application/json'
https://api.bitbucket.org/2.0/workspaces/my-workspace/hooks
-d '
{
"description": "Webhook Description",
"url": "https://example.com/",
"active": true,
"secret": "this is a really bad secret",
"events": [
"repo:push",
"issue:created",
"issue:updated"
]
}'
When the secret is provided it will be used as the key to generate a HMAC digest value sent in the X-Hub-Signature header at delivery time. Passing a null or empty secret or not passing a secret will leave the webhook's secret unset. Bitbucket only generates the X-Hub-Signature when the webhook's secret is set.
This call requires the webhook scope, as well as any scope that applies to the events that the webhook subscribes to. In the example above that means: webhook, repository and issue.
The url must properly resolve and cannot be an internal, non-routed address.
Only workspace owners can install webhooks on workspaces.
Request
- Base URLhttps://api.bitbucket.org/2.0
- URLhttps://api.bitbucket.org/2.0/workspaces/{workspace}/hooks
- Auth
- OAuth 2Authorization code: https://bitbucket.org/site/oauth2/authorizeToken URL: https://bitbucket.org/site/oauth2/access_token scopes: webhook
- or HTTP basic
- or API key in header Authorization
Path parameters
This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.
Response
The webhook subscription object.
Changes
- breaking
added the new path request parameter
workspace - info
api operation id
create_workspace_hookwas added - info
added the optional property
/to the response with the status - info
the response optional property
/became read-only for the status - info
the response optional property
/became read-only for the status - info
the response optional property
/became read-only for the status - info
the response optional property
/became read-only for the status
- breaking
- warning
added the new
pipeline:span_createdenum value to the//response property for the response status - warning
added the new
pullrequest:pushenum value to the//response property for the response status
- warning