着信および発信Webhook

着信と発信の両方のWebhookは、BitriseAPIを使用して設定できます。これらは、自動ビルドトリガーおよびビルドイベントのその他のサービスへのレポートにとって重要です。

表1 着信および発信Webhookに関連するエンドポイント

エンドポイント

関数

POST / apps / {app-slug} / register-webhook

特定のアプリケーションの着信Webhookを登録します。

GET / apps / {app-slug} / outgoing-webhooks

アプリの発信Webhookを一覧表示します。

POST / apps / {app-slug} / outgoing-webhooks

アプリの発信Webhookを作成します。

PUT / apps / {app-slug} / outgoing-webhooks / {app-webhook-slug}

アプリの発信Webhookを更新します。

DELETE / apps / {app-slug} / outgoing-webhooks / {app-webhook-slug}

アプリの発信Webhookを削除します。


着信WebhookをAPIに登録する

着信Webhookを使用すると、ユーザーはBitriseでアプリの自動トリガーを設定できます。たとえば、GitHubに登録されているBitrise Webhookは、コードがGitHubリポジトリにプッシュされたときにビルドを自動的にトリガーできます。

Webhookを設定するには、次のことを行う必要があります BitriseアカウントをGitプロバイダーアカウントに接続します:これにより、BitriseはWebhookを自動的に登録できます。

を呼び出してWebhookを登録します register-webhook 既存のアプリスラッグを持つエンドポイント:

curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/register-webhook'

これにより、アプリのGitプロバイダーにWebhookが登録されます。その後、設定することができます 自動トリガー ウェブサイトまたはアプリのトリガーマップを介して bitrise.yml ファイル。

APIを使用した発信Webhookの作成

発信Webhookは、他のサービスとの統合を可能にします。具体的には、他のサービスに通知するために使用されます。現在、ビルドイベント通知のみがサポートされています。サポートされているビルドイベントには、ビルドのトリガーとビルドの終了の2つがあります。

ステータスレポートの作成

ビルドステータスについてGitプロバイダーに通知する場合、発信Webhookは必要ありません。

アプリケーションの発信Webhookを設定するには、アプリ自体と少なくとも2つの作成パラメーターを指定する必要があります。

  • Webhook URL:これはBitriseと統合したいサービスから取得できます。

  • Webhookをトリガーするイベント。現在、これには2つの可能な値があります。 allbuild

リクエストでキーと値のペアを指定して、カスタムヘッダーを設定することもできます。

例1 URLが「example.webhook.com」の新しい発信Webhook

リクエスト:

curl -X POST "https://api.bitrise.io/v0.1/apps/APP-SLUG/outgoing-webhooks" -H "accept: application/json" -H "Authorization: ACCESS-TOKEN" -H "Content-Type: application/json" -d "{ \"events\": [ \"build\" ], \"url\": \"example.webhook.com\", \"headers\": { \"KEY\": \"value\" }}"

応答:

{
  "slug": "01D72ARNH4KR7KMW3DG3NBKXRK",
  "url": "example.webhook.com",
  "events": [
    "build"
  ],
  "headers": {
    "KEY": "value"
  },
  "created_at": "2019-03-28T14:20:22.436825Z",
  "updated_at": "2019-03-28T14:20:22.436825Z"
}

APIを使用した発信Webhookの変更と削除

既存のWebhookを変更するには、リクエストですべての必須パラメーターを指定する必要があります。つまり、URLのみを変更したい場合でも、リクエストには有効な値が含まれている必要があります。 events パラメータ。

例1 発信Webhookの変更

リクエスト:

curl -X PUT "https://api.bitrise.io/v0.1/apps/APP-SLUG/outgoing-webhooks/WEBHOOK-SLUG" -H "accept: application/json" -H "Authorization: ACCESS-TOKEN" -H "Content-Type: application/json" -d "{ \"events\": [ \"all\" ], \"url\": \"example2.webhook.com\"}"

応答:

{
  "data": {
    "slug": "01D72ARNH4KR7KMW3DG3NBKXRK",
    "url": "example2.webhook.com",
    "events": [
      "all"
    ],
    "headers": null,
    "created_at": "2019-03-28T14:20:22.436825Z",
    "updated_at": "2019-03-28T14:20:22.436825Z"
  }
}

発信Webhookを削除するには、リクエストにアプリスラッグとWebhookスラッグを指定するだけです。

curl -X DELETE "https://api.bitrise.io/v0.1/apps/APP-SLUG/outgoing-webhooks/WEBHOOK-SLUG" -H "accept: application/json" -H "Authorization: ACCESS-TOKEN"