App Store Connectヘルプ

サポート / App Store Connect / チームの管理 / Webhookの管理

チームの管理

Webhookの管理

App Store ConnectでWebhook URLを定義すると、アプリのアップデートや変更が行われたときにウェブサーバで自動通知を受け取ることができます。アプリへの変更には、以下のものが該当します。

このような通知を受け取るには、使用しているウェブサーバ上にエンドポイント(Webhook)を実装します。イベントトリガーその処理方法について詳しくは、それぞれのリンク先を参照してください。

1つのWebhookは1つのアプリにのみ用いることができます。1つのアプリにつき作成できるWebhookの数は、最大10件です。

App Store Connect APIを使用してWebhookを管理する方法については、こちらを参照してください。

必要な役割:Account Holder、Admin、またはApp Manager。「役割の権限」を参照してください。

Webhookの作成

  1. 「ユーザとアクセス」で、「統合」をクリックします。

  2. 「その他」の下にある「Webhook」をクリックします。

  3. 「Webhook」の横にある追加ボタン(+)をクリックします。

  4. 「ユーザとアクセス」セクションのスクリーンショット。「名前」、「ペイロードURL」、「イベントタイプ」、「アプリ」の列のある表が表示されています。次の2つのWebhookが表示されています。1つ目は、アプリの各種ステータスにリンクされた「Exercise」というアプリのもの。2つ目は「Backyard Birds」というアプリにリンクされた新着のスクリーンショットフィードバックのもの。新しいWebhookを追加するためのプラスボタンがあります。
  5. Webhookに付ける名前を入力します。

  6. フォームのスクリーンショット。「名前」、「ペイロードURL」、「シークレット」、ドロップダウンメニュー付きの「アプリ」というラベルの付いたフィールドがある。イベントトリガーに関するオプションもある。
  7. ペイロードURLを入力します。このURLが通知の送信先になります。

  8. シークレットを入力します。ここで指定した文字列は、サーバに届いたWebhookがApp Store Connectから送出された正規のものであることをサーバ側で確認するために使用します。

  9. 通知の受信対象のアプリを選択します。

  10. 通知の受信対象のイベントトリガーを1つ以上選択します。

  11. 「追加」をクリックします。

Webhookの送信のテスト

  1. 「ユーザとアクセス」で、「統合」をクリックします。

  2. 「その他」の下にある「Webhook」をクリックします。

  3. 右側の表で、テストするWebhookをクリックします。

  4. ページの右上隅にある「テスト」をクリックします。

  5. サーバに宛てて、テスト用のWebhookが送信されます。送信履歴は、「最近の送信」の表にPingイベントトリガーとともに表示されます。

Webhookの詳細の管理

Webhookに関連付けた名前、シークレット、ペイロードURL、イベントトリガーは、いつでも編集できます。既存のWebhookに関連付けられているアプリを変更することはできません。アプリを変更する必要がある場合は、目的のアプリで使用するWebhookを新たに作成してください。

  1. 「ユーザとアクセス」で、「統合」をクリックします。

  2. 「その他」の下にある「Webhook」をクリックします。

  3. 右側の表で、編集対象のWebhookをクリックします。

  4. 必要な変更を加え、「保存」をクリックします。

  5. 変更は即時有効になります。

Webhookをオフにする

Webhookをオフにすると、通知の送信を一時的に停止できます。調整が済んだら、同様の手順でWebhookを再びオンにします。

  1. 「ユーザとアクセス」で、「統合」をクリックします。

  2. 「その他」の下にある「Webhook」をクリックします。

  3. 右側の表で、編集対象のWebhookをクリックします。

  4. 「Webhookをオフにする」をクリックします。Webhookを再びオンにするには、「Webhookをオンにする」をクリックします。

  5. 「確認」をクリックします。

Webhookの削除

Webhookを削除して、App Store Connectから完全に消去することができます。これは、元に戻せない操作です。

  1. 「ユーザとアクセス」で、「統合」をクリックします。

  2. 「その他」の下にある「Webhook」をクリックします。

  3. 右側の表で、編集対象のWebhookをクリックします。

  4. 「Webhookを削除」をクリックします。

  5. 「確認」をクリックします。

最近送信したWebhookの表示

  1. 「ユーザとアクセス」で、「統合」をクリックします。

  2. 「その他」の下にある「Webhook」をクリックします。

  3. 右側の表で、送信履歴を表示するWebhookをクリックします。

  4. 「最近の送信」で、直近1週間に送信された最大20件の履歴について、イベントID、イベントタイプ、作成日、およびステータスを見ることができます。

  5. また、表の右上にある更新アイコンを使って、最近の送信履歴の一覧を更新することもできます。

    Webhookの送信ステータスに表示されるのは、以下のとおりです。

    ステータス

    説明

    成功

    Webhookのサーバへの送信が成功しました。

    保留中

    Webhookはサーバに送信中です。

    失敗

    Webhookのサーバへの送信に失敗しました。Webhookの再送信を試みることができます。

  6. イベントIDをクリックすると、イベントID、ペイロードのリクエスト、応答ペイロードなどの追加情報があれば表示されます。

Webhookの再送信

ステータスが「失敗」または「成功」のWebhookは、再送信を実行することができます。テスト用の送信を再実行することはできません。

Webhookの再送信では、同一のイベントIDで新たな送信レコードが作成されます。再送信を実行した後に、同じものを再送信することはできません。ただし、新たに送信レコードを作成して再送信することはできます。

  1. 「ユーザとアクセス」で、「統合」をクリックします。

  2. 「その他」の下にある「Webhook」をクリックします。

  3. 右側の表で、再送信を実行するWebhookをクリックします。

  4. 「最近の送信」で「失敗」ステータスの項目を見つけ、「再送信」をクリックします。