{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Workspaces - Webhooks API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Workspaces - Webhooks",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian List Webhooks For A Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/hooks",
"params": [
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a paginated list of webhooks installed on this workspace."
},
{
"info": {
"name": "Atlassian Create A Webhook For A Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/workspaces/:workspace/hooks",
"params": [
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates 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\",
"
},
{
"info": {
"name": "Atlassian Get A Webhook For A Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/hooks/:uid",
"params": [
{
"name": "uid",
"value": "",
"type": "path",
"description": "Installed webhook's ID"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the webhook with the specified id installed on the given
workspace."
},
{
"info": {
"name": "Atlassian Update A Webhook For A Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/workspaces/:workspace/hooks/:uid",
"params": [
{
"name": "uid",
"value": "",
"type": "path",
"description": "Installed webhook's ID"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the specified webhook subscription.
The following properties can be mutated:
* `description`
* `url`
* `secret`
* `active`
* `events`
The hook's secret is used as a key to generate the HMAC hex digest sent in the
`X-Hub-Signature` header at delivery time. This signature is only generated
when the hook has a secret.
Set the hook's secret by passing the new value in the `secret` field. Passing a
`null` value in the `secret` field will remove"
},
{
"info": {
"name": "Atlassian Delete A Webhook For A Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/workspaces/:workspace/hooks/:uid",
"params": [
{
"name": "uid",
"value": "",
"type": "path",
"description": "Installed webhook's ID"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the specified webhook subscription from the given workspace."
}
]
}
],
"bundled": true
}