送信Webhookの追加
Bitrise CIを設定すると、任意のサービスにビルドイベントの通知を送信できます。ビルドイベントには次のものがあります。
- ビルドが開始されたとき。
- ビルドが終了したとき。
Bitrise Release Management向けにアウトゴーイングWebhookを設定することもできます。これらのWebhookはrelease managementイベントによってトリガーされます。Release Managementでのアウト ゴーイングWebhook。
Bitriseがまだ対応していないGitプロバイダーであっても、この通知を使ってビルドステータスを共有したり、ビルドの成功や失敗を適切なチームだけに通知したり、社内のリリースパイプラインの自動化に使ったりできます。
Webhookの追加、削除、編集はWebインターフェースから行えます。
ファイアウォールの内側にあるサービスにアクセスする必要がある場合、アウトゴーイングWebhookは使用できません。ペイロードがファイアウォールを通過できないためです。このようなサービスにアクセスするには、ファイアウォールを設定してBitrise build machinesからのアクセスを許可し、build machine内からリクエストを送信することをお勧めします。詳しい方法については、関連ガイドを確認してください。
Bitrise projectへアウトゴーイングWebhookを追加するClick to copy link
Bitriseが送信するWebhookは、WebUIでセットアップおよび設定できます。手順を見ていきましょう。
-
プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。
-
プロジェクトのメインページで、Project settingsボタンをクリックします。
-
左側でIntegrationsを選択し、Webhooksタブを選択します。
-
Outgoing Webhooksまでスクロールします。
-
Add webhookをクリックします。
-
通知を送信したいサービスのURLをURLフィールドに入力します。
-
Send me すべてまたはSelect 個々のイベントのいずれかのオプションを選択します。
- Send me すべて: サポートされているすべてのイベントタイプがWebhookをトリガーします。現在サポートされているのはビルドイベントのみですが、今後他のオプションも追加される予定です。
- Select 個々のイベント: Webhookをトリガーする個々のイベントを指定できます。
-
必要に応じて、Webhookにカスタムヘッダーを追加します。Headersセクションで、ヘッダーの名前と値を指定します。完了したらAdd headerをクリックします。
たとえば、WebhookをリッスンするAPIがある場合、カスタムヘッダーとして設定したAPIキーでリクエストを追跡できます。
header valueを非表示にするHideの下にあるチェックボックスをオンにすると、ヘッダーの値を非表示にできます。ただし、これを行うと値を再度表示したり変更したりできなくなりますのでご注意ください。
-
Create Webhookをクリックします。
これで完了です。Webhookの横にある鉛筆アイコンをクリックすると、いつでもWebhookを変更できます。
Release ManagementのためにWebhookを作成した場合は、詳細ガイドのRelease ManagementでのアウトゴーイングWebhookを確認してください。
アウトゴーイングWebhookにカスタムヘッダーを追加するClick to copy link
WebインターフェースのWebhooksタブから、アウトゴーイングWebhookに追加のヘッダーを設定できます。たとえば、WebhookをリッスンするAPIがある場合、カスタムヘッダーとして設定したAPIキーでリクエストを追跡できます。
カスタムヘッダーは、次のいずれかのタイミングで追加できます。
- 新しいアウトゴーイングWebhookを作成する。
- URLの横にあるEditボタンをクリックして、既存のアウトゴーイングWebhookを変更する。
ヘッダーを追加する方法は次のとおりです。
-
プロジェクトに対するAdminのロールを持つユー ザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。
-
プロジェクトのメインページで、Project settingsボタンをクリックします。
-
左側でIntegrationsを選択し、Webhooksタブに移動します。
-
Outgoing webhooksセクションでWebhookを見つけ、Editボタンをクリックします。
-
Headersセクションで、キーと値を追加します。ヘッダーを保存するには両方が必要です。
-
Add headerをクリックします。
-
Update Webhookをクリックします。
アウトゴーイングWebhookの配信を確認するClick to copy link
アウトゴーイングWebhookのrecent deliveriesはいつでも確認でき、必要に応じて再送できます。配信が成功したかどうかに応じて、適切なステータスコードが表示されます。
-
プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。
-
プロジェクトのメインページで、Project settingsボタンをクリックします。
-
左側でIntegrationsを選択し、Webhooksタブを選択します。
-
Outgoing Webhooksまでスクロールします。
-
Webhookを見つけて、
アイコンを選択します。 -
配信を選択して展開し、リクエストとレスポンスの全体を表示します。
-
Webhookのペイロードはいつでも再配信できます。必要な配信を見つけて、その横にある
アイコンをクリックします。ペイロードを編集するWebhookのペイロードを再送信する前に、webhook configurationを編集できます。Recent deliveriesポップアップウィンドウを閉じ、Webhookの横にある
アイコンをクリックして編集します。完了したらUpdate Webhookをクリックします。