Bitbucket サポート

robots

noindex

In order to improve user privacy in accordance with GDPR regulations, Bitbucket and other Atlassian Cloud products are updating our product APIs to consolidate how we manage access to personal data. These API changes are necessary to support upcoming improvements to Atlassian products that give users greater control over who can see and access their data.

username エンドポイントと username フィールドの提供は 2019 年 4 月 12 日に停止する予定です。アトラシアンではこれらを置き換えるため、すぐに使用できる複数の新しいデータポイントを導入します。詳細は、API の廃止のお知らせを参照してください。

イベントに関連付けられた Webhook がある場合、Bitbucket はイベントが発生するたびに Webhook のサーバー URL にイベントリクエストを送信します。このページでは、これらのリクエストの構造について説明します。

HTTPS エンドポイントに関連付けられた Webhook のイベントペイロードリクエストを Bitbucket が送信する場合、URL に公的な認証局が署名した有効な SSL 証明書があることを確認してください。

また、許可リストに追加する Bitbucket Cloud IP アドレスもご確認ください。

次のペイロードには、5 つの一般的なエンティティタイプである、User、Repository、Issue、Comment、および Pull Request が含まれています。これらは、ペイロードが表示されるすべての場所で一貫して表示されます。たとえば、repo:push ペイロードの actor プロパティはイベントのユーザーを表します。共通エンティティセクションには、これらのエンティティの例が記載されています。

HTTP ヘッダー

すべてのイベントペイロードには次の HTTP ヘッダーがあります。

HTTP ヘッダー	説明
`X-Event-Key`	Webhook をトリガーするイベントのイベントキー (例: `repo:push`)。
`X-Hook-UUID`	イベントがトリガーする Webhook の UUID。Webhook の UUID の詳細については、「Webhook リソース」を参照してください。
`X-Request-UUID`	リクエストの UUID。
`X-Attempt-Number`	Bitbucket がペイロードの送信を試みた回数。最初のリクエストの後、以前の試行が失敗した場合、Bitbucket はさらに 2 回ペイロードの送信を試みます。試行回数には、[リクエストの再送] ボタンから実行したすべてのユーザーの操作も含まれます。

リポジトリイベント

リポジトリで発生する次のイベント用に Webhook を作成できます。

プッシュ

ユーザーは 1 つ以上のコミットをリポジトリにプッシュします。このペイロードには repo:push のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター説明

actor コミットをプッシュしたユーザー。User エンティティの例を参照してください。

repository コミットがあるリポジトリ。Repository エンティティの例を参照してください。

push

プッシュの詳細 (changes プロパティを含む)。このプロパティには、プッシュが更新したすべての references を含む配列と、次のプロパティが含まれます。

new: プッシュ後の参照状態に関する情報を含むオブジェクト。ブランチが削除されると、new は null になります。new には以下のプロパティが含まれます。
- type: 変更の参照タイプ。
  - Git リポジトリの branch、または tag。
  - Mercurial リポジトリの named_branch、bookmark、または tag。
- name: ブランチ、タグ、名前付きブランチ、またはブックマークの名前。
- target: プッシュ後の最新のコミットの詳細。
- links: API (self および commits) および Bitbucket (html) のリファレンスへのリンク。
old: プッシュ前のリファレンスの状態に関する情報を含むオブジェクト。ブランチが作成されると、old は null になります。old には以下のプロパティが含まれます。
- type: 変更の参照タイプ:
  - Git リポジトリの branch、tag、または annotated_tag。
  - Mercurial リポジトリの named_branch または bookmark。
- name: ブランチ、タグ、名前付きブランチ、またはブックマークの名前。
- target: プッシュ前の最新のコミットの詳細。
- links: API (self および commits) および Bitbucket (html) のリファレンスへのリンク。
links : Bitbucket (html)、API (commits)、および diff 形式 (diff) の変更へのリンク。
created: true または false。リファレンスが新しいかどうかを示します。
closed: true または false。リファレンスが古いかどうかを示します。
forced: true または false。プッシュが強制されたかどうかを示します。
commits: そのリファレンスにプッシュされた最新のコミット (最大 5 つ) を含む配列。コミットが 5 件よりも多いプッシュの配列は切り捨てられ、truncated プロパティで示されます。配列には、新しいコミットに加えて次のコミットも含まれる場合があります。
- そのリファレンスにプッシュされていないコミット - リファレンスが最近作成された場合、リポジトリへプッシュされたが、この特定のリファレンスにはプッシュされていないコミットがある可能性があります。この場合、配列には、このような以前プッシュしたコミットも含まれます。たとえば、多数のコミットがある master ブランチから新しいフィーチャーブランチを作成し、そこに 1 件のコミットをプッシュすると、ペイロードの配列には、5 件のコミット (すべてがそのフィーチャーブランチにとって新しいコミット) が含まれます。これらのコミットには、先ほど行った 1 つのコミットと、master ブランチの最新コミット 4 件が含まれます。
- 強制的にプッシュされたコミット - リベースの後に強制プッシュを実行すると、古いリファレンスのコミットはすべて新しいリファレンス内のコミットに置き換えられます。その結果、配列には新しいリファレンスのコミット部分が含まれるようになります。配列には、リベースまたは強制プッシュの際に削除されたコミットは含まれません。
truncated: true または false。Bitbucket がこのペイロードの commits 配列を切り捨てたかどうかを表示します。5 件よりも多くコミットがプッシュされると、配列は切り捨てられます。その場合、commits 配列には、最新 5 件のコミットのみが含まれます。

repo:push payload

{    
  "actor": User,
  "repository": Repository,
  "push": {
    "changes": [
      {
        "new": {
          "type": "branch",
          "name": "name-of-branch",
          "target": {
            "type": "commit",
            "hash": "709d658dc5b6d6afcd46049c2f332ee3f515a67d",
            "author": User,
            "message": "new commit message\n",
            "date": "2015-06-09T03:34:49+00:00",
            "parents": [
              {
                "type": "commit",
                "hash": "1e65c05c1d5171631d92438a13901ca7dae9618c",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commit/8cbbd65829c7ad834a97841e0defc965718036a0"
},
                  "html": {
                    "href": "https://bitbucket.org/user_name/repo_name/commits/8cbbd65829c7ad834a97841e0defc965718036a0"
                  }
                }
              }
            ],
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commit/c4b2b7914156a878aa7c9da452a09fb50c2091f2"
},
              "html": {
                "href": "https://bitbucket.org/user_name/repo_name/commits/c4b2b7914156a878aa7c9da452a09fb50c2091f2"
              }
            }
          },
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/refs/branches/master"
},
            "commits": {
              "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commits/master"
},
            "html": {
              "href": "https://bitbucket.org/user_name/repo_name/branch/master"
            }
          }
        },
        "old": {
          "type": "branch",
          "name": "name-of-branch",
          "target": {
            "type": "commit",
            "hash": "1e65c05c1d5171631d92438a13901ca7dae9618c",
            "author": User,
            "message": "old commit message\n",
            "date": "2015-06-08T21:34:56+00:00",
            "parents": [
              {
                "type": "commit",
                "hash": "e0d0c2041e09746be5ce4b55067d5a8e3098c843",
                "links": {
                  "self": {
                    "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commit/9c4a3452da3bc4f37af5a6bb9c784246f44406f7"
},
                  "html": {
                    "href": "https://bitbucket.org/user_name/repo_name/commits/9c4a3452da3bc4f37af5a6bb9c784246f44406f7"
                  }
                }
              }
            ],
            "links": {
              "self": {
                "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commit/b99ea6dad8f416e57c5ca78c1ccef590600d841b"
},
              "html": {
                "href": "https://bitbucket.org/user_name/repo_name/commits/b99ea6dad8f416e57c5ca78c1ccef590600d841b"
              }
            }
          },
          "links": {
            "self": {
              "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/refs/branches/master"
},
            "commits": {
              "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commits/master"
},
            "html": {
              "href": "https://bitbucket.org/user_name/repo_name/branch/master"
            }
          }
        },
        "links": {
          "html": {
            "href": "https://bitbucket.org/user_name/repo_name/branches/compare/c4b2b7914156a878aa7c9da452a09fb50c2091f2..b99ea6dad8f416e57c5ca78c1ccef590600d841b"
          },
          "diff": {
            "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/diff/c4b2b7914156a878aa7c9da452a09fb50c2091f2..b99ea6dad8f416e57c5ca78c1ccef590600d841b"
          },
          "commits": {
            "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commits?include=c4b2b7914156a878aa7c9da452a09fb50c2091f2&exclude=b99ea6dad8f416e57c5ca78c1ccef590600d841b"
          }
        },
        "created": false,
        "forced": false,
        "closed": false,

        "commits": [

            "hash": "03f4a7270240708834de475bcf21532d6134777e",

            "type": "commit",

            "message": "commit message\n",

            "author": User,

            "links": {

              "self": {

                "href": "https://api.bitbucket.org/2.0/repositories/user/repo/commit/03f4a7270240708834de475bcf21532d6134777e"

},

              "html": {

                "href": "https://bitbucket.org/user/repo/commits/03f4a7270240708834de475bcf21532d6134777e"

],

        "truncated": false

      }
    ]
  }
}

フォーク

ユーザーはリポジトリをフォークします。このペイロードには repo:fork のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	リポジトリをフォークするユーザー。このユーザーはフォークの所有者でもあります。User エンティティの例を参照してください。
`repository`	フォークされた元のリポジトリ。`Repository` エンティティの例を参照してください。
`fork`	フォークの結果として生成された新しいリポジトリ。`Repository` エンティティの例を参照してください。

repo:fork

{
  "actor": User,

  "repository": Repository,

  "fork": Repository

更新日

ユーザーは、名前、説明、Web サイト、または言語フィールドをリポジトリ設定の [リポジトリの詳細] ページで更新します。このペイロードには repo:updated のイベントキーが含まれており、次のフィールドを提供します。

パラメーター説明

actor 更新を行ったユーザー。User エンティティの例を参照してください。

repository 更新されたリポジトリ。Repository エンティティの例を参照してください。

changes

変更の詳細 (新しい設定と以前の設定内容を含む)。ペイロードには、値が変更されたプロパティのみが含まれます。

name: リポジトリの新しい (new) 名前と古い (old) 名前。
website: リポジトリの新しい (new) Web サイトと古い (old) Web サイト。
language: リポジトリの新しい (new) 言語と古い (old) 言語。
links: リポジトリのアバター (avatar)、API のリポジトリ (self)、および Bitbucket のリポジトリ (html) の新しい (new) リンクと古い (old) リンク。
description: リポジトリの新しい (new) 説明と古い (old) 説明。
full_name: リポジトリの新しい (new) フルネームと古い (old) フルネーム。これには、チームまたはユーザーのアカウント名、スラッシュ (/)、およびリポジトリ名が含まれます。

repo:updated payload

{
  "actor": User,
  "repository": Repository,
  "changes": {
    "name": {

      "new": "repository",

      "old": "repository_name"

    "website": {

      "new": "http://www.example.com/",

      "old": ""

    }
    "language": {

      "new": "java",

      "old": ""

    "links": {
      "new": {

        "avatar": {
          "href": "https://bitbucket.org/teamawesome/repository/avatar/32/"

        },
        "self": {
          "href": "https://api.bitbucket.org/2.0/repositories/teamawesome/repository"
}

        "html": {

          "href": "https://bitbucket.org/teamawesome/repository"

},

      "old": {

        "avatar": {

          "href": "https://bitbucket.org/teamawesome/repository_name/avatar/32/"

},

        "self": {

          "href": "https://api.bitbucket.org/2.0/repositories/teamawesome/repository_name"

},

        "html": {

          "href": "https://bitbucket.org/teamawesome/repository_name"

      }
    },

    "description": {

      "new": "This is a better description.",

      "old": "This is a description."

    "full_name": {

      "new": "teamawesome/repository",

      "old": "teamawesome/repository_name"

    }
  }

転送

リポジトリの譲渡が許可されます。これには repo:transfer のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
actor	リポジトリを譲渡したユーザー。User エンティティの例を参照してください。
repository	譲渡されたリポジトリ。`Repository` エンティティの例を参照してください。
previous_workspace	リポジトリの以前のコンテナ。Workspace エンティティの例を参照してください。

repo:transfer ペイロード

{
  "actor": User,
  "repository": Repository,
  "previous_workspace": Workspace

作成したコメントのコミット

ユーザーはリポジトリのコミットにコメントを追加します。このペイロードには repo:commit_comment_created のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	コミットにコメントを追加したユーザー。`User` エンティティの例を参照してください。
`comment`	作成されたコメント。`Comment` エンティティの例を参照してください。
`repository`	コミットがあるリポジトリ。`Repository` エンティティの例を参照してください。
`commit`	コミットの詳細 (ハッシュを含む)。

repo:commit_comment_created ペイロード

{
  "actor": User,
  "comment": Comment,
  "repository": Repository,
  "commit": {
    "hash": "d3022fc0ca3d65c7f6654eea129d6bf0cf0ee08e"
  }
}

ビルドステータスの作成

ビルドシステム、CI ツール、または別のベンダーでは、ユーザーによるコミットのプッシュを認識し、コミットをそのステータスで更新します。このペイロードには repo:commit_status_created のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター説明

actor コミットを作成したユーザー。User エンティティの例を参照してください。

repository コミットがあるリポジトリ。Repository エンティティの例を参照してください。

commit_status

コミットステータスの詳細。次のプロパティが含まれています。

name: コミットステータスの名前。
description: コミットステータスの説明。
state: コミットステータス。INPROGRESS、SUCCESSFUL、または FAILED のいずれかです。
key: ステータスを同じコミットに関連付けられた他のステータスと識別するためにシステムまたはベンダーが提供するキー。
url: ステータスを生成するベンダーまたはシステムへの URL。
type: コミットステータスのタイプ。現時点では、Bitbucket はコミットステータスをビルドと関連付けることのみ可能です。したがって、サポートされているタイプは build のみです。
created_on: コミットステータスが作成された日時 (ISO 8601 フォーマット)。
updated_on: コミットステータスが最後に更新された日時 (ISO 8601 フォーマット)。
links: API または Bitbucket でのコミットおよびコミットステータスの表現へのリンク。

repo:commit_status_created ペイロード

{
  "actor": User,
  "repository": Repository,
  "commit_status": {
    "name": "Unit Tests (Python)",
    "description": "Build started",
    "state": "INPROGRESS",
    "key": "mybuildtool",
    "url": "https://my-build-tool.com/builds/MY-PROJECT/BUILD-777",
"type": "build",
    "created_on": "2015-11-19T20:37:35.547563+00:00",
"updated_on": "2015-11-19T20:37:35.547563+00:00",

    "links": {
      "commit": {
        "href": "http://api.bitbucket.org/2.0/repositories/tk/test/commit/9fec847784abb10b2fa567ee63b85bd238955d0e"
},
      "self": {
        "href": "http://api.bitbucket.org/2.0/repositories/tk/test/commit/9fec847784abb10b2fa567ee63b85bd238955d0e/statuses/build/mybuildtool"
}
    }
  }
}

ビルドステータスの更新

ビルドシステム、CI ツール、または別のベンダーでは、コミットの新しいステータスを認識し、コミットをそのステータスで更新します。このペイロードには repo:commit_status_updated のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター説明

actor コミットを作成したユーザー。User エンティティの例を参照してください。

repository コミットがあるリポジトリ。Repository エンティティの例を参照してください。

commit_status

コミットステータスの詳細。次のプロパティが含まれています。

name: コミットステータスの名前。
description: コミットステータスの説明。
state: コミットステータス。INPROGRESS、SUCCESSFUL、または FAILED のいずれかです。
key: ステータスを同じコミットに関連付けられた他のステータスと識別するためにシステムまたはベンダーが提供するキー。
url: ステータスを生成するベンダーまたはシステムへの URL。
type: コミットステータスのタイプ。現時点では、Bitbucket はコミットステータスをビルドと関連付けることのみ可能です。したがって、サポートされているタイプは build のみです。
created_on: コミットステータスが作成された日時 (ISO 8601 フォーマット)。
updated_on: コミットステータスが最後に更新された日時 (ISO 8601 フォーマット)。
links: API または Bitbucket でのコミットおよびコミットステータスの表現へのリンク。

repo:commit_status_updated ペイロード

{
  "actor": User,
  "repository": Repository,
  "commit_status": {
    "name": "Unit Tests (Python)",
    "description": "All tests passed",
    "state": "SUCCESSFUL",
    "key": "mybuildtool",
    "url": "https://my-build-tool.com/builds/MY-PROJECT/BUILD-792",
"type": "build",
    "created_on": "2015-11-19T20:37:35.547563+00:00",
"updated_on": "2015-11-20T08:01:16.433108+00:00",

    "links": {
      "commit": {
        "href": "http://api.bitbucket.org/2.0/repositories/tk/test/commit/9fec847784abb10b2fa567ee63b85bd238955d0e"
},
      "self": {
        "href": "http://api.bitbucket.org/2.0/repositories/tk/test/commit/9fec847784abb10b2fa567ee63b85bd238955d0e/statuses/build/mybuildtool"
}
    }
  }
}

課題のイベント

課題で発生する次のイベントのために webhook を作成できます。

作成日

ユーザーによるリポジトリでの課題の作成です。このペイロードには issue:created のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	課題を作成したユーザー。`User` エンティティの例を参照してください。
`issue`	ユーザーが作成した課題。`Issue` エンティティの例を参照してください。
`repository`	課題があるリポジトリ。`Repository` エンティティの例を参照してください。

issue:created ペイロード

{
  "actor": User,
  "issue": Issue,
  "repository": Repository
}

更新日

ユーザーによるリポジトリの課題の更新です。このペイロードには issue:updated のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	課題を作成したユーザー。User エンティティの例を参照してください。
`issue`	ユーザーが作成した課題。`Issue` エンティティの例を参照してください。
`repository`	課題があるリポジトリ。`Repository` エンティティの例を参照してください。
`comment`	課題への更新について追加されたコメント。`Comment` エンティティの例を参照してください。
`changes`	課題に対する変更の詳細。次のプロパティが含まれています。 `old`: 課題フィールドの前の値。 `new`: 課題フィールドの新しい値。

issue:updated ペイロード

{
  "actor": User,
  "issue": Issue,
  "repository": Repository,

  "comment": Comment,

  "changes": {

    "status": {

      "old": "open",

      "new": "on hold"

コメントの作成

ユーザーによる、リポジトリに関連付けられている課題へのコメントの追加です。このペイロードには issue:comment_created のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	課題にコメントを追加するユーザー。`User` エンティティの例を参照してください。
`repository`	課題があるリポジトリ。`Repository` エンティティの例を参照してください。
`issue`	作成された課題。`Issue` エンティティの例を参照してください。
`comment`	作成されたコメント。`Comment` エンティティの例を参照してください。

issue:comment_created ペイロード

  "actor": User,
  "repository": Repository,
  "issue": Issue,
  "comment": Comment
}

プルリクエストイベント

プルリクエストで発生する次のイベントのために webhook を作成できます。

作成日

ユーザーによるリポジトリでのプルリクエストの作成です。このペイロードには pullrequest:created のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストを作成するユーザー。User エンティティの例を参照してください。
`pullrequest`	新しいプルリクエスト。`Pull Request` エンティティの例を参照してください。
`repository`	課題を含むリポジトリの表現。`Repository` エンティティの例を参照してください。

pullrequest:created ペイロード

{
  "actor": User,
  "pullrequest": PullRequest,
  "repository": Repository
}

更新日

ユーザによるリポジトリでのプルリクエストの更新です。このペイロードには pullrequest:updated のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストを更新するユーザー。`User` エンティティの例を参照してください。
`pullrequest`	更新されたプルリクエスト。`Pull Request` エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリ。`Repository` エンティティの例を参照してください。

pullrequest:updated ペイロード

{
  "actor": User,
  "pullrequest": PullRequest,
  "repository": Repository
}

承認

ユーザーによるリポジトリでのプルリクエストの承認です。このペイロードには pullrequest:approved のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストを承認するユーザー。User エンティティの例を参照してください。
`pullrequest`	承認済みのプルリクエスト。`Pull Request` エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリ。`Repository` エンティティの例を参照してください。
`approval`	承認の詳細。次のプロパティが含まれています。 `date`: 承認の作成日。 `user`: 承認を作成したユーザー。

pullrequest:approved ペイロード

{
  "actor": User,
  "pullrequest": PullRequest,
  "repository": Repository,
  "approval": {
    "date": "2015-04-06T16:34:59.195330+00:00",
"user": User
  }
}

承認の取り消し

ユーザーによるリポジトリでのプルリクエストからの承認の削除です。このペイロードには pullrequest:unapproved のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	承認を取り消すユーザー。User エンティティの例を参照してください。
`pullrequest`	削除された承認のプルリクエスト。`Pull Request` エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリの表現。`Repository` エンティティの例を参照してください。
`approval`	承認の詳細。次のプロパティが含まれています。 `date`: 承認の作成日。 `user`: 承認を作成したユーザー。

pullrequest:unapproved ペイロード

{
  "actor": User,
  "pullrequest": PullRequest,
  "repository": Repository,
  "approval": {
    "date": "2015-04-06T16:34:59.195330+00:00",
"user": User
  }
}

マージ

ユーザーによるリポジトリでのプルリクエストのマージです。このペイロードには pullrequest:fulfilled のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストをマージするユーザー。User エンティティの例を参照してください。
`pullrequest`	マージされたプルリクエスト。`Pull Request` エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリ。`Repository` エンティティの例を参照してください。

pullrequest:fulfilled ペイロード

{
  "actor": User,
  "pullrequest": PullRequest,
  "repository": Repository

却下

ユーザーによるリポジトリでのプルリクエストの却下です。このペイロードには pullrequest:rejected のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストを却下したユーザー。`User` エンティティの例を参照してください。
`pullrequest`	却下されたプルリクエスト。`Pull Request` エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリ。`Repository` エンティティの例を参照してください。

pullrequest:rejected ペイロード

{
  "actor": User,
  "pullrequest": PullRequest,
  "repository": Repository

コメントの作成

ユーザーによるプルリクエストへのコメント追加です。このペイロードには pullrequest:comment_created のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストにコメントするユーザー。User エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリ。`Repository` エンティティの例を参照してください。
`pull request`	コメントを持つプルリクエスト。`Pull Request` エンティティの例を参照してください。
`comment`	作成されたコメント。`Comment` エンティティの例を参照してください。

pullrequest:comment_created ペイロード

  "actor": User,
  "repository": Repository,
  "pullrequest": PullRequest,
  "comment": Comment
}

コメントの更新

ユーザーによるプルリクエストのコメントの更新です。ユーザーが同じ再びすぐにコメントを更新する場合、Bitbucket は初回のコメント更新時にのみイベントリクエストを送信します。ユーザーが時間を空けてから再度コメントを更新する場合、Bitbucket は 2 回目にイベントリクエストを送信します。

このペイロードには pullrequest:comment_updated のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストのコメントを更新したユーザー。`User` エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリ。`Repository` エンティティの例を参照してください。
`pull request`	コメントを持つプルリクエスト。`Pull Request` エンティティの例を参照してください。
`comment`	更新されたコメント。`Comment` エンティティの例を参照してください。

pullrequest:comment_updated ペイロード

  "actor": User,
  "repository": Repository,
  "pullrequest": PullRequest,
  "comment": Comment
}

コメントの削除

ユーザーによるプルリクエストのコメントの削除です。このペイロードには pullrequest:comment_deleted のイベントキーが含まれており、次のフィールドが提供されます。

パラメーター	説明
`actor`	プルリクエストでコメントを削除するユーザー。User エンティティの例を参照してください。
`repository`	プルリクエストが所属するリポジトリ。`Repository` エンティティの例を参照してください。
`pull request`	コメントを持つプルリクエスト。`Pull Request` エンティティの例を参照してください。
`comment`	削除されたコメント。`Comment` エンティティの例を参照してください。

pullrequest:comment_deleted ペイロード

  "actor": User,
  "repository": Repository,
  "pullrequest": PullRequest,
  "comment": Comment
}

イベントペイロードの一般的なエンティティ

このセクションでは、ペイロードでユーザー、リポジトリ、課題、コメント、またはプルリクエストを表現する方法についての例を紹介します。

ワークスペース

イベントペイロードの Workspace。以下のフィールドに加え、workspace エンティティには他のフィールドも含まれている場合があります。

パラメーター	説明
type	常に “workspace”。
slug	URL で使用されるワークスペースのスラッグ。
name	ワークスペース名。
uuid	全体で一意のワークスペース ID。
links	API または Bitbucket でのワークスペースの表現へのリンク。

リポジトリ

イベントペイロードの Repository です。以下のフィールドに加え、repository エンティティには他のフィールドも含まれる場合があります。

パラメーター	説明
`type`	プロパティタイプ。この場合は `repository`。
`name`	リポジトリの名前
`full_name`	"/" で続けられる、ワークスペースとリポジトリのスラッグ。
workspace	リポジトリを含むワークスペース。ワークスペースのエンティティ例を設定します。
`uuid`	全体で一意のユーザーまたはリポジトリ ID。
`links`	API または Bitbucket でのリポジトリの表現へのリンク。
`project`	リポジトリが含まれるプロジェクト (存在する場合)。`Project` エンティティの例を参照してください。
`website`	特定の Web サイトでコードがホストされている場合のリポジトリの Web サイトへの URL。
`scm`	リポジトリのタイプ: Git (`git`) または Mercurial (`hg`)。
`is_private`	`true` または `false`。リポジトリが非公開がどうかを示します。

repository プロパティ

  "type": "repository",

  "links": {
    "self": {
      "href": "https://api.bitbucket.org/api/2.0/repositories/bitbucket/bitbucket"
},
    "html": {
      "href": "https://api.bitbucket.org/bitbucket/bitbucket"
},
    "avatar": {
      "href": "https://api-staging-assetroot.s3.amazonaws.com/c/photos/2014/Aug/01/bitbucket-logo-2629490769-3_avatar.png"
}
  },
  "uuid": "{673a6070-3421-46c9-9d48-90745f7bfe8e}",

  "project": Project,
  "full_name": "workspace_slug/repoitory_slug",

  "workspace": Workspace,
  "name": "repo_name",

  "website": "https://mywebsite.com/",

  "scm": "git",

  "is_private": true
},

プロジェクト

イベントペイロードの Project です。以下のフィールドに加え、project エンティティには他のフィールドも含まれる場合があります。

パラメーター	説明
`type`	プロパティタイプ。この場合は `project`。
`name`	プロジェクトの名前。
`uuid`	全体で一意のユーザーまたはチーム ID。
`links`	プロジェクトのアバターまたは Bitbucket でのプロジェクトの表現へのリンク。
`key`	プロジェクトのキー。

project プロパティ

{
  "type": "project",

  "project": "Untitled project",
  "uuid": "{3b7898dc-6891-4225-ae60-24613bb83080}",

  "links": {
    "html": {
      "href": "https://bitbucket.org/account/user/teamawesome/projects/proj"
    },
    "avatar": {
      "href": "https://bitbucket.org/account/user/teamawesome/projects/proj/avatar/32"
    }
  },

  "key": "proj"
},

課題

イベントペイロードの Issue です。以下のフィールドに加え、issue エンティティには他のフィールドも含まれる場合があります。

パラメーター	説明
`id`	課題の ID 番号。
`component`	課題のコンポーネント。
`title`	課題のタイトル。
`content`	課題の説明。 `raw`: ユーザーが入力した生のテキスト `markup`: 使用されたマークアップ言語 `html`: マークアップのレンダリングされた HTML バージョン
`priority`	課題の優先度カテゴリ。
`state`	課題のステータス。
`type`	課題のタイプ。
`milestone`	課題が到達したマイルストーン。
`version`	課題に関連付けられたバージョン番号。
`created_on`	課題が作成された日時 (ISO 8601 形式)。
`updated_on`	課題が最後に更新された日時 (ISO 8601 形式)。
`links`	API または Bitbucket での課題の表現へのリンク。

issue プロパティ

"id" : 1 ,

"component" : "component" ,

"title" : "Issue title" ,

"content" : {

"raw" : "Issue description" ,

"html" : "<p>Issue description</p>" ,

"markup" : "markdown"

},

"priority" : "trivial|minor|major|critical|blocker" ,

"type" : "bug|enhancement|proposal|task" ,

"milestone" : { "name" : "milestone 1" },

"version" : { "name" : "version 1" },

"created_on" : "2015-04-06T15:23:38.179678+00:00" ,

"updated_on" : "2015-04-06T15:23:38.179678+00:00" ,

  "links": {
    "self": {
      "href": "https://api.bitbucket.org/api/2.0/issues/issue_id"
},
    "html": {
      "href": "https://api.bitbucket.org/issue_id"
}
  }

}

パラメーター	説明
`id`	コメントの ID 番号。
`parent`	コメントの親コメントの ID 番号。
`content`	実際のコメント。以下の子要素が含まれています。 `raw`: ユーザーが入力した生のテキスト `markup`: 使用されたマークアップ言語 `html`: マークアップのレンダリングされた HTML バージョン
`inline`	コメントがインラインコードコメントかどうかを示します。以下の子要素が含まれています。 `to`: コメントが追加された、差分の新しいバージョンでの行番号 (緑色の行)。新しいバージョンに行が存在しない場合は `null`。 `from`: コメントが追加された、差分の古いバージョンでの行番号 (赤色の行)。古いバージョンに行が存在しない場合は `null`。 `path`: コメントが追加されたファイルの名前。インラインコメントの links セクションには、生ファイルの差分を参照する追加のリンク (rel:`"code"`) もあります。
`created_on`	課題が作成された日時 (ISO 8601 形式)。
`updated_on`	課題が最後に更新された日時 (ISO 8601 形式)。
`links`	API または Bitbucket でのコメントの表現へのリンク。

comment プロパティ

"id" : 17 ,

"parent" : { "id" : 16 },

"content" : {

"raw" : "Comment text" ,

"html" : "<p>Comment text</p>" ,

"markup" : "markdown" ,

},

"inline" : {

"path" : "path/to/file" ,

"from" : null ,

"to" : 10

},

"created_on" : "2015-04-06T16:52:29.982346+00:00" ,

"updated_on" : "2015-04-06T16:52:29.983730+00:00",

  "links": {
    "self": {
      "href": "https://api.bitbucket.org/api/2.0/comments/comment_id"
},
    "html": {
      "href": "https://api.bitbucket.org/comment_id"
}
  }

}

Pull request

イベントペイロードの Pull Request です。以下のフィールドに加え、pull request エンティティには他のフィールドも含まれる場合があります。

パラメーター	説明
`id`	プルリクエストを識別する ID 番号。
`title`	プルリクエストの名前。
`description`	プルリクエストの説明。
`state`	プルリクエストのステータス。
`author`	プルリクエストの作成者。
`source`	プルリクエストのソースに関する情報。以下の子要素が含まれています。 `branch`: ブランチの名前 `commit`: ブランチの先頭の SHA1 `repository`: そのブランチのリポジトリの表現
`destination`	プルリクエストの宛先に関する情報。以下の子要素が含まれています。 `branch`: ブランチの名前 `commit`: ブランチの先頭の SHA1 `repository`: そのブランチのリポジトリの表現
`merge_commit`	プルリクエストがマージされるときのコミットの SHA1。
`participants`	プルリクエストの参加者の一覧。
`reviewers`	プルリクエストのレビュアーの一覧。
`close_source_branch`	`true` または `false`。プルリクエストが正常にマージされたあとに Bitbucket がソースブランチをクローズ必要があるかどうかを示します。このパラメータは、ソースと宛先が同じリポジトリにある場合にのみ使用します。
`closed_by`	マージまたは却下によってプルリクエストをクローズしたユーザー。
`reason`	プルリクエストが却下された理由 (必要に応じて)。
`created_on`	プルリクエストが作成された日時 (ISO 8601 形式)。
`updated_on`	プルリクエストが最後に更新された日時 (ISO 8601 形式)。
`links`	API または Bitbucket でのプルリクエストの表現へのリンク。

pull request プロパティ

"id" : 1 ,

"title" : "Title of pull request" ,

"description" : "Description of pull request" ,

"state" : "OPEN|MERGED|DECLINED" ,

"author" : User,

"source" : {

"branch" : { "name" : "branch2" },

"commit" : { "hash" : "d3022fc0ca3d" },

"repository" : Repository

},

"destination" : {

"branch" : { "name" : "master" },

"commit" : { "hash" : "ce5965ddd289" },

"repository" : Repository

},

"merge_commit" : { "hash" : "764413d85e29" },

"participants" : [User],

"reviewers" : [User],

"close_source_branch" : true ,

"closed_by" : User,

"reason" : "reason for declining the PR (if applicable)" ,

"created_on" : "2015-04-06T15:23:38.179678+00:00" ,

"updated_on" : "2015-04-06T15:23:38.205705+00:00",

  "links": {
    "self": {
      "href": "https://api.bitbucket.org/api/2.0/pullrequests/pullrequest_id"
},
    "html": {
      "href": "https://api.bitbucket.org/pullrequest_id"
}
  }

}

ページ

Viewport

Confluence

バージョン

イベント ペイロード

Webhook を管理する

このページの内容

関連コンテンツ

お困りですか?

HTTP ヘッダー

リポジトリ イベント

プッシュ

フォーク

更新日

転送

作成したコメントのコミット

ビルド ステータスの作成

ビルド ステータスの更新

課題のイベント

作成日

更新日

コメントの作成

プル リクエスト イベント

作成日

更新日

承認

承認の取り消し

マージ

却下

コメントの作成

コメントの更新

コメントの削除

イベント ペイロードの一般的なエンティティ

ワークスペース

リポジトリ

プロジェクト

課題

コメント

Pull request

関連コンテンツ

イベントペイロード

リポジトリイベント

ビルドステータスの作成

ビルドステータスの更新

プルリクエストイベント

イベントペイロードの一般的なエンティティ