REST APIs for Slack notifications for Bitbucket app

The REST APIs are primary for the internal use and can be changed without notice.

This application was acquired by Votazz.

Please seek support here - https://marketplace.atlassian.com/vendors/1219338/votazz

The new guides are here - https://docs.votazz.co/

Slack notifications for Bitbucket REST APIs

Slack notifications for Bitbucket provides the following endpoints:

Get all configurations
```
GET <BITBUCKET_BASE_URL>/rest/mwf-slack/1.0/configurations
```
Permission: Global admin permissions are required.

Get configurations for a project

GET <BITBUCKET_BASE_URL>/rest/mwf-slack/1.0/configurations?projectKey=PROJECT_KEY

Permission: Global or project admin permissions are required.

Get configurations for the repository

GET <BITBUCKET_BASE_URL>/rest/mwf-slack/1.0/configurations?projectKey=PROJECT_KEY&repositorySlug=REPOSITORY_SLUG

Permission: Global, project or repository admin permissions are required.

Get configuration by ID
```
GET <BITBUCKET_BASE_URL>/rest/mwf-slack/1.0/configurations/ID
```
Permission: Global, project or repository admin permissions are required.
Create new configuration
```
POST <BITBUCKET_BASE_URL>/rest/mwf-slack/1.0/configurations
```
Permission: Admin on the level (global, project, repository) the configuration is created.

Update configuration by ID

PUT GET <BITBUCKET_BASE_URL>/rest/mwf-slack/1.0/configurations/ID

Permission: Admin on the level (global, project, repository) the configuration is created.

Delete configuration by ID

DELETE <BITBUCKET_BASE_URL>/rest/mwf-slack/1.0/configurations/ID

Permission: Admin on the level (global, project, repository) the configuration is created.

Configuration scheme

{
   "id": integer, 
   "enabled":boolean,
   "lastModified":long, //readonly timestamp
   "destinations":[
      {
         "url": string, // URL
         "slackUserName":string,
         "channelName":string,
         "channelSource": enum, // "FROM" or "TO"
         "slackApi":enum, //"WEBHOOK", "OAUTH"
         "token":string,
         "tenantId": string,
         "channelId": string
      }
   ],
   "users":[
      string  // usernames
   ],
   "ignoredUsers":[
      string  // usernames
   ],
   "groups":[
      string  // user groups
   ],
   "ignoredGroups":[
      string  // user groups
   ],
   "projectKey": string, // project key
   "repositorySlug": string, // optional repository slug
   "eventTypes":[
      enum // "PULL_REQUEST_ACTIVITY", "REPOSITORY_PUSH", "BUILD_STATUS_SET"
   ],
   "pullRequestBranchSource": enum, // "FROM" or "TO"
   "overrideEnabled": boolean,
   "notificationLevel": enum, // "VERBOSE", "COMPACT", "MINIMAL"
   "notificationPrLevel": enum, // "VERBOSE", "COMPACT", "MINIMAL"
   "slackIconUrl": string,
   "slackIconEmoji": string,
   "pullRequestActions":[
      enum // "OPENED", "REOPENED","UPDATED","APPROVED","UNAPPROVED","DECLINED","MERGED","COMMENTED","REVIEWED"
   ],
   "pullRequestReviewersAdded":boolean,
   "pullRequestReviewersRemoved":boolean,
   "enabledForPersonal":boolean,
   "alwaysAddPrReviewers":boolean,
   "level": enum, //readonly "REPOSITORY", "REPOSITORY", "GLOBAL"
}

Updated: 2024-03-16