イベント ペイロード

GDPR 規制に従ってユーザーのプライバシーを向上させるため、Bitbucket やその他の Atlassian Cloud 製品では個人データへのアクセスの管理方法を統一するために製品 API の更新を進めています。これらの API の変更は、アトラシアン製品で今後予定されている改善である、データの表示およびアクセスを許可するユーザーのより詳細な制御をサポートするために必要です。

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


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

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

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

次のペイロードには、5 つの一般的なエンティティ タイプである、U serRepositoryIssueComment、および 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: プッシュ後の参照状態に関する情報を含むオブジェクト。ブランチが削除されると、newnull になります。new には次のプロパティが含まれます。

    • type: 変更の参照タイプ。

      • Git リポジトリの場合は branch または tag

      • Mercurial の場合は named_branchbookmark または tag

    • name: ブランチ、タグ、名前付きブランチ、またなブックマークの名前。

    • target: プッシュ後の最新のコミットの詳細。

    • links: API (self および commits) および Bitbucket (html) のリファレンスへのリンク。

  • old: プッシュ前のリファレンスの状態に関する情報を含むオブジェクト。ブランチが作成されると、old は null になります。old には次のプロパティが含まれます。

    • type: 変更の参照タイプ。

      • Git リポジトリの場合は branchtag、または annotated_ tag

      • Mercurial リポジトリの場合は named_branch または bookmark

    • name: ブランチ、タグ、名前付きブランチ、またなブックマークの名前。

    • target: プッシュ前の最新のコミットの詳細。

    • links: API (self および commits) および Bitbucket (html) のリファレンスへのリンク。

  • links: Bitbucket (html)、API (commits)、および diff 形式 (diff) の変更へのリンク。

  • createdtrue または false。リファレンスが新しいかどうかを示します。

  • closedtrue または false。リファレンスが古いかどうかを示します。

  • forcedtrue または false。プッシュが強制されたかどうかを示します。

  • commits: そのリファレンスにプッシュされた最新のコミット (最大 5 つ) を含む配列。コミットが 5 件よりも多いプッシュの配列は切り捨てられ、truncated プロパティで示されます。配列には、新しいコミットに加えて次のコミットも含まれる場合があります。

    • このリファレンスにプッシュされていないコミット – リファレンスが最近作成された場合、リポジトリへプッシュされてもこの特定のリファレンスにはプッシュされていないコミットがある可能性があります。その場合、配列には以前プッシュしたコミットも含まれます。たとえば、多数のコミットがある main ブランチから新しい feature ブランチを作成してそこに 1 件のコミットをプッシュすると、ペイロードの配列には 5 件のコミット (すべてがその feature ブランチにとって新しいコミット) が含まれます。これらのコミットには、先ほど行った 1 つのコミットと main ブランチの最新コミット 4 件が含まれます。

    • 強制的にプッシュされたコミット - リベースの後に強制プッシュを実行すると、古いリファレンスのコミットは新しいリファレンス内のすべてのコミットに置き換えられます。その結果、配列には新しいリファレンスのコミット部分が含まれるようになります。配列には、リベースまたは強制プッシュの際に削除されたコミットは含まれません。

  • truncated: true または false。Bitbucket がこのペイロードの commits 配列を切り捨てたかどうかを表示します。5 件よりも多くのコミットがプッシュされると、配列は切り捨てられます。その場合、commits 配列には、最新 5 件のコミットのみが含まれます。

 


repo:push payload

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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 { "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/main" }, "commits": { "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commits/main" }, "html": { "href": "https://bitbucket.org/user_name/repo_name/branch/main" } } }, "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/main" }, "commits": { "href": "https://api.bitbucket.org/2.0/repositories/user_name/repo_name/commits/main" }, "html": { "href": "https://bitbucket.org/user_name/repo_name/branch/main" } } }, "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

1 2 { "actor": User,
1 "repository": Repository,
1 "fork": Repository
1 }

更新日

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

パラメーター

説明

actor

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

repository

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

変更

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

  • 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

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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 { "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:fork のイベント キーが含まれており、次のフィールドが提供されます。

パラメーター

説明

1 actor

リポジトリを譲渡したユーザー。User エンティティの例を参照してください。

1 repository

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

1 previous_workspace

リポジトリの以前のコンテナ。Workspace エンティティの例を参照してください。

repo:transfer ペイロード

1 2 3 4 5 { "actor": User, "repository": Repository, "previous_workspace": Workspace }


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

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

パラメーター

説明

actor

コミットにコメントを追加したユーザー。User エンティティの例を参照してください。

comment

作成されたコメント。Comment エンティティの例を参照してください。

repository

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

commit

コミットの詳細 (ハッシュを含む)。

repo:commit_comment_created ペイロード

1 2 3 4 5 6 7 8 { "actor": User, "comment": Comment, "repository": Repository, "commit": { "hash": "d3022fc0ca3d65c7f6654eea129d6bf0cf0ee08e" } }

ビルド ステータスの作成

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

パラメーター

説明

actor

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

repository

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

commit_status

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

  • name: コミット ステータスの名前。

  • description: コミット ステータスの説明。

  • state: コミット ステータス。ステータスは INPROGRESSSUCCESSFUL、または FAILED のいずれかです。

  • key: ステータスを同じコミットと関連付けられた他のステータスと識別するためにシステムまたはベンダーが提供するキー。

  • url: ステータスを生成するベンダーまたはシステムへの URL。

  • type: コミット ステータスのタイプ。現時点では、Bitbucket はコミット ステータスをビルドと関連付けることのみ可能です。したがって、サポートされているタイプは build のみです。

  • created_on: コミット ステータスが作成された日時 (ISO 8601 フォーマット)。 

  • updated_on: コミット ステータスが最終更新された日時 (ISO 8601 フォーマット)。

  • links: API または Bitbucket でのコミットおよびコミット ステータスの説明へのリンク。

repo:commit_status_created ペイロード

1 2 3 4 5 6 7 8 9 10 11 12 { "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",
1 2 3 4 5 6 7 8 9 10 "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: コミット ステータス。ステータスは INPROGRESSSUCCESSFUL、または FAILED のいずれかです。

  • key: ステータスを同じコミットと関連付けられた他のステータスと識別するためにシステムまたはベンダーが提供するキー。

  • url: ステータスを生成するベンダーまたはシステムへの URL。

  • type: コミット ステータスのタイプ。現時点では、Bitbucket はコミット ステータスをビルドと関連付けることのみ可能です。したがって、サポートされているタイプは build のみです。

  • created_on: コミット ステータスが作成された日時 (ISO 8601 フォーマット)。 

  • updated_on: コミット ステータスが最終更新された日時 (ISO 8601 フォーマット)。

  • links: API または Bitbucket でのコミットおよびコミット ステータスの説明へのリンク。

repo:commit_status_updated ペイロード

1 2 3 4 5 6 7 8 9 10 11 12 { "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",
1 2 3 4 5 6 7 8 9 10 "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 を作成できます。

created

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

パラメーター

説明

actor

課題を作成したユーザー。User エンティティの例を参照してください。

課題

ユーザーが作成した課題。Issue エンティティの例を参照してください。

repository

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

issue:created ペイロード

1 2 3 4 5 { "actor": User, "issue": Issue, "repository": Repository }

更新日

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

パラメーター

説明

actor

課題を作成したユーザー。User エンティティの例を参照してください。

課題

ユーザーが作成した課題。Issue エンティティの例を参照してください。

repository

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

comment

課題への更新について追加されたコメント。Comment エンティティの例を参照してください。

変更

課題に対する変更の詳細。次のプロパティが含まれています。

  • old: 課題フィールドの前の値。

  • new: 課題フィールドの新しい値。

issue:updated ペイロード

1 2 3 4 { "actor": User, "issue": Issue, "repository": Repository,
1 "comment": Comment,
1 "changes": {
1 "status": {
1 "old": "open",
1 "new": "on hold"
1 }
1 }
1 }

コメントの作成

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

パラメーター

説明

actor

課題にコメントを追加するユーザー。User エンティティの例を参照してください。

repository

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

課題

作成された課題。Issue エンティティの例を参照してください。

comment

作成されたコメント。Comment エンティティの例を参照してください。

issue:comment_created ペイロード

1 {
1 2 3 4 5 "actor": User, "repository": Repository, "issue": Issue, "comment": Comment }

プル リクエスト イベント

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

created

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

パラメーター

説明

actor

プル リクエストを作成するユーザー。User エンティティの例を参照してください。

pullrequest

新しいプル リクエスト。Pull Request エンティティの例を参照してください。

repository

課題を含むリポジトリの表現。Repository エンティティの例を参照してください。

pullrequest:created ペイロード

1 2 3 4 5 { "actor": User, "pullrequest": PullRequest, "repository": Repository }

更新日

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

パラメーター

説明

actor

プル リクエストを更新するユーザー。User エンティティの例を参照してください。

pullrequest

更新されたプル リクエスト。Pull Request エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリ。Repository エンティティの例を参照してください。

pullrequest:updated ペイロード

1 2 3 4 5 { "actor": User, "pullrequest": PullRequest, "repository": Repository }

作成された変更リクエスト

ユーザーはリポジトリへのプル リクエストの変更をリクエストしています。このペイロードには、「pullrequest:changes_request_created」のイベント キーが含まれており、以下のフィールドがあります。

パラメーター

説明

actor

プル リクエストへの変更をリクエストしているユーザー。User エンティティの例を参照してください。

pullrequest

作成済みの変更リクエストがあるプル リクエスト。Pull Request エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリ。Repository エンティティの例を参照してください。

changes_request

以下のプロパティを含む変更リクエストの詳細:

  • date: 変更リクエストの作成日。

  • user: 変更リクエストを作成したユーザー。

pullrequest:changes_request_created payload

1 2 3 4 5 6 7 8 9 { "actor": User, "pullrequest": PullRequest, "repository": Repository, "changes_request": { "date": "2015-04-06T16:34:59.195330+00:00", "user": User } }

削除された変更リクエスト

ユーザーはリポジトリへのプル リクエストから変更リクエストを削除しています。このペイロードには、「pullrequest:changes_request_removed」イベント キーが含まれており、以下のフィールドがあります。

パラメーター

説明

actor

リクエストした変更を削除しているユーザー。User エンティティの例を参照してください。

pullrequest

削除された変更リクエストがあるプル リクエスト。Pull Request エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリの表現。Repository エンティティの例を参照してください。

changes_request

以下のプロパティを含む変更リクエストの詳細:

  • date: 変更リクエストの削除日。

  • user: 変更リクエストを削除したユーザー。

pullrequest:changes_request_removed payload

1 2 3 4 5 6 7 8 9 { "actor": User, "pullrequest": PullRequest, "repository": Repository, "changes_request": { "date": "2015-04-06T16:34:59.195330+00:00", "user": User } }

承認

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

パラメーター

説明

actor

プル リクエストを承認するユーザー。User エンティティの例を参照してください。

pullrequest

プル リクエストの承認Pull Request エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリ。Repository エンティティの例を参照してください。

approval

承認の詳細。次のプロパティが含まれています。

  • date: 承認の作成日

  • user: 承認を作成したユーザー

pullrequest:approved ペイロード

1 2 3 4 5 6 7 8 9 { "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 ペイロード

1 2 3 4 5 6 7 8 9 { "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 ペイロード

1 2 3 4 { "actor": User, "pullrequest": PullRequest, "repository": Repository
1 }

却下

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

パラメーター

説明

actor

プル リクエストを却下したユーザー。User エンティティの例を参照してください。

pullrequest

プル リクエストの却下Pull Request エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリ。Repository エンティティの例を参照してください。

pullrequest:rejected ペイロード

1 2 3 4 { "actor": User, "pullrequest": PullRequest, "repository": Repository
1 }

コメントの作成

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

パラメーター

説明

actor

プル リクエストにコメントするユーザー。User エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリ。Repository エンティティの例を参照してください。

プルリクエスト

コメントを持つプル リクエスト。Pull Request エンティティの例を参照してください。

comment

作成されたコメント。Comment エンティティの例を参照してください。

pullrequest:comment_created ペイロード

1 {
1 2 3 4 5 "actor": User, "repository": Repository, "pullrequest": PullRequest, "comment": Comment }

コメントの更新

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

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

パラメーター

説明

actor

プル リクエストのコメントを更新したユーザー。User エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリ。Repository エンティティの例を参照してください。

プルリクエスト

コメントを持つプル リクエスト。Pull Request エンティティの例を参照してください。

comment

更新されたコメント。Comment エンティティの例を参照してください。

pullrequest:comment_updated ペイロード

1 {
1 2 3 4 5 "actor": User, "repository": Repository, "pullrequest": PullRequest, "comment": Comment }

コメントの削除

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

パラメーター

説明

actor

プル リクエストでコメントを削除するユーザー。User エンティティの例を参照してください。

repository

プル リクエストが所属するリポジトリ。Repository エンティティの例を参照してください。

プルリクエスト

コメントを持つプル リクエスト。Pull Request エンティティの例を参照してください。

comment

削除されたコメント。Comment エンティティの例を参照してください。

pullrequest:comment_deleted ペイロード

1 {
1 2 3 4 5 "actor": User, "repository": Repository, "pullrequest": PullRequest, "comment": Comment }

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

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

ワークスペース

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

パラメーター

説明

1 type

常に “workspace”。

1 slug

URL で使用されるワークスペースのスラッグ。

1 name

ワークスペース名。

1 uuid

全体で一意のワークスペース ID。

1 links

API または Bitbucket でのワークスペースの表現へのリンク。

リポジトリ

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

パラメーター

説明

type

プロパティ タイプ。この場合は、リポジトリ

name

リポジトリの名前

full_name

"/" で続けられる、ワークスペースとリポジトリのスラッグ。

1 workspace

リポジトリを含むワークスペース。ワークスペースのエンティティ例を設定します。

uuid

全体で一意のユーザーまたはリポジトリ ID。

links

API または Bitbucket でのリポジトリの表現へのリンク。

project

リポジトリが含まれるプロジェクト (存在する場合)。Project エンティティの例を参照してください。

website

特定の Web サイトでコードがホストされている場合のリポジトリの Web サイトへの URL。

scm

リポジトリのタイプ: Git (git) または Mercurial (hg)。

is_private

true または false。リポジトリがプライベートがどうかを示します。

repository プロパティ

1 {
1  "type": "repository",
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 "links": { "self": { "href": "https://api.bitbucket.org/api/2.0/repositories/bitbucket/bitbucket" }, "html": { "href": "https://api.bitbucket.org/bitbucket/bitbucket" }, "avatar": { "href": "https://example.com/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。次のフィールドに加え、project エンティティには他のフィールドも含まれる場合があります。

パラメーター

説明

type

プロパティ タイプ。この場合は、プロジェクト

name

プロジェクトの名前

uuid

全体で一意のユーザーまたはチーム ID。

links

プロジェクトのアバターまたは Bitbucket でのプロジェクトの表現へのリンク。

鍵 (キー)

プロジェクトのキー

project プロパティ

1 2 {  "type": "project",
1 2 "project": "Untitled project", "uuid": "{3b7898dc-6891-4225-ae60-24613bb83080}",
1 2 3 4 5 6 7 8 9 10 11 "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。次のフィールドに加え、issue エンティティには他のフィールドも含まれる場合があります。

パラメーター

説明

ID

課題の ID 番号。

component

課題のコンポーネント。

title

課題のタイトル。

content

課題の説明。

  • raw: ユーザーが入力した生のテキスト

  • markup: 使用されているマークアップ言語

  • html: マークアップのレンダリングされた HTML バージョン

priority

課題の優先度カテゴリ。

state

課題のステータス。

type

課題のタイプ。

マイルストーン

課題が到達したマイルストーン。

VERSION (バージョン)

課題に関連付けられたバージョン番号。

created_on

課題が作成された日時 (ISO 8601 形式)。 

updated_on

課題が最後に更新された日時 (ISO 8601 形式)。 

links

API または Bitbucket での課題の表現へのリンク。

issue プロパティ

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 32 33 34 35 36 37 38 39 40 41 { "id" :  1 ,    "component" :  "component" ,    "title" :  "Issue title" ,    "content" : {      "raw" :  "Issue description" ,      "html" :  "<p>Issue description</p>" ,      "markup" :  "markdown"    },    "priority" :  "trivial|minor|major|critical|blocker" ,    "state" :  "new|open|on hold|resolved|duplicate|invalid|wontfix|closed" ,    "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" } } }

コメント

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

パラメーター

説明

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 プロパティ

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 32 33 34 35 36 37 38 39 {    "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

プル リクエストの作成者。

ソース

プル リクエストのソースに関する情報。以下の子要素が含まれています。

  • branch: ブランチの名前。

  • commit: ブランチ ヘッドの SHA1

  • repository: そのブランチのリポジトリの表現

destination

プル リクエストの宛先に関する情報。以下の子要素が含まれています。

  • branch: ブランチの名前。

  • commit: ブランチ ヘッドの SHA1

  • repository: そのブランチのリポジトリの表現

merge_commit

プル リクエストがマージされるときのコミットの SHA1。

参加者

プル リクエストの参加者の一覧。

reviewers

プル リクエストのレビュアーの一覧。

close_source_branch

true または false。プル リクエストが正常にマージされた後、Bitbucket がソース ブランチをクローズ必要があるかどうかを示します。このパラメータは、ソースと宛先が同じリポジトリにある場合にのみ使用します。

closed_by

マージまたは却下によってプル リクエストをクローズしたユーザー。

理由

プル リクエストが却下された理由 (必要に応じて)。

created_on

プル リクエストが作成された日時 (ISO 8601 形式)。 

updated_on

プル リクエストが最後に更新された日時 (ISO 8601 形式)。

links

API または Bitbucket でのプル リクエストの表現へのリンク。

pull request プロパティ

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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 {    "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" :  "main" },      "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" } } }

 

最終更新日 2021年06月24日)
次でキャッシュ 8:59 PM on Oct 21, 2021 |

その他のヘルプ