発信Webhookの追加

概要

Bitriseがビルドイベント通知を任意のサービスに自動的に送信するように、発信Webhookを作成できます。

ビルドイベント通知を任意のサービスに送信するようにBitriseを構成できます。ビルドイベントは次のとおりです。

  • ビルドが開始されたとき。

  • ビルドが終了したとき。

この通知を使用して、まだサポートされていない場合はビルドステータスをgitプロバイダーと共有したり、ビルドの成功または失敗について適切なチームにのみ通知したり、社内リリースパイプラインを自動化するために使用したりできます。

Webサイトのインターフェイスで、Webhookを簡単に追加、削除、編集できます。

ファイアウォールの背後にあるサービスへのアクセス

ファイアウォールの背後にあるサービスにアクセスする必要がある場合、発信Webhookを使用することはできません。ペイロードはファイアウォールを通過しません。このようなサービスにアクセスするには、Bitriseビルドマシンがアクセスできるようにファイアウォールを構成してから、ビルドマシン内からリクエストを行うことをお勧めします。その方法の詳細については、関連するガイドを確認してください。

発信Webhookをアプリに追加する

Bitriseによって送信されるWebhookをWebUIでセットアップおよび構成できます。方法を見てみましょう!

  1. 上のアプリのページに移動します bitrise.io を開きます コード タブ。

  2. クリック + Webhookを追加する

    Adding outgoing webhooks
  3. 通知を送信するサービスのURLをに入力します URL 分野。

  4. いずれかを選択します 私にすべてを送ってください または 個々のイベントを選択します オプション。

    • 私にすべてを送ってください:サポートされているすべてのイベントタイプがWebhookをトリガーします。現在、ビルドイベントのみがサポートされていますが、将来的には他のオプションもあります。

    • 個々のイベントを選択します:Webhookをトリガーする個々のイベントを指定できます。

  5. クリック Webhookを作成する

そして、あなたは完了です!クリックするといつでもWebhookを変更できます 編集 表示されたWebhookURLの横。

発信Webhookへのカスタムヘッダーの追加

を介して発信Webhookにヘッダーを追加できます コード Webインターフェイスのタブ。たとえば、WebhookをリッスンするAPIがある場合、カスタムヘッダーとして設定されたAPIキーを使用してリクエストを追跡できます。

次の場合にカスタムヘッダーを追加できます。

ヘッダーを追加するには:

  1. を見つける WEBHOOKヘッダー セクション。

    Adding outgoing webhooks
  2. キーと値をヘッダーに追加します。ヘッダーを保存できるようにするには、両方が必要です。

  3. クリック ヘッダーを追加

  4. クリック Webhookを作成する/Webhookを更新する

Webhook配信の確認と再送信

通知が正常に送信されたかどうかを確認でき、ペイロードと応答の両方を確認できます。配信は、配信が成功したかどうかに応じて、適切なステータスコードでマークされます。そうであった場合は、緑色のチェックマークが表示されます。失敗した場合は、オレンジ色の三角形が表示されます。

  1. に移動します 最近の配達 のセクション 発信Webhook メニュー。

  2. 発信Webhookをクリックします。

    Adding outgoing webhooks
  3. を選択 リクエスト タブを表示して、必要に応じて、指定したURLに送信されたペイロードを変更します。

    ペイロードの例:

    {
      "build_slug": "58f4da148d884d68",
      "build_number": 3,
      "app_slug": "de7829a7317d976e",
      "build_status": 0,
      "build_triggered_workflow": "primary",
      "git": {
        "provider": "github",
        "src_branch": "master",
        "dst_branch": "master",
        "pull_request_id": 0,
        "tag": null
      }
    }
  4. を選択 応答 タブをクリックして、通知を送信したサービスからの応答を確認します。

  5. あなたはどんな配達でも再配達することができます。必要な配信を開き、をクリックします 再配信

    Adding outgoing webhooks