Apple Business ConnectでWebhookを設定する
APIアクセス権を持つサードパーティパートナーは、さまざまなリソースやイベントが関係する状況の変化について、Webhookを使用してプッシュ通知を受け取ることができます。Webhookを使用して受け取る通知の種類は、Notifications APIから受け取るものと同一です。
注記: Webhookを使用するには、Apple Business ConnectへのAPIアクセス権を持ち、環境ごとにAppleの承認を受ける必要があります。「APIアクセスをリクエストする」を参照してください。
最初のWebhookを作成する
Apple Business Connectにサインインしていない場合は、管理者の役割を持つユーザでサインインします。
複数の会社の管理者である場合は、会社のリスト
から該当する会社を選択します。サイドバーで会社を選択し、会社名の下にある「API」を選択します。
「Webhookを追加する」の横にある
を選択し、以下の情報を入力します。情報
説明
Webhook
英数字と記号を含めることができますが、以下は使用できません。
;（セミコロン）
’（アポストロフィ）
[（開き角括弧）
]（閉じ角括弧）
<（小なり記号）
>（大なり記号）
チームメンバー
接続障害が発生した場合に連絡先となる、管理者またはデベロッパの役割を持つチームメンバー
環境
制限事項：
Webhookの設定後は環境を変更できない
イベントを使用できるのは環境ごとに1回のみ
ペイロードURL
先頭はhttps://とすること
イベント
少なくとも1つのリソースまたはその他のイベントを選択する必要がある
注記: Webhookの情報を追加すると、接続確認のためにURLにpingが送信されます。
「保存」を選択します。
「コピー」ボタンを選択して、クライアントシークレットをクリップボードにコピーします。
クライアントシークレットをWebhookの管理者と共有します。
管理者がクライアントシークレットを受け取ったことを確認したら、「完了」を選択します。
Webhookを編集する
Apple Business Connectにサインインしていない場合は、管理者の役割を持つユーザでサインインします。
複数の会社の管理者である場合は、会社のリスト
から該当する会社を選択します。サイドバーで会社を選択し、会社名の下にある「API」を選択します。
「Webhookを管理する」の横にある
を選択し、リストからWebhookを選択します。以下の情報を変更できます。
Webhookの名前
Webhookのステータス
接続障害が発生した場合に連絡先となるチームメンバーの名前
ペイロードURL
必要に応じて「新しいクライアントシークレットを作成する」を選択し、「作成」を選択します。
クライアントシークレットをWebhookの管理者と共有します。
管理者がクライアントシークレットを受け取ったことを確認したら、「完了」を選択します。
通知を受け取りたいリソースとイベントをすべて選択します。
注記: 同じWebhook環境で使用されているリソースを複数のWebhookで使用することはできません。
「保存」を選択します。
Webhookのステータスを表示または変更する
Apple Business Connectにサインインしていない場合は、管理者の役割を持つユーザでサインインします。
複数の会社の管理者である場合は、会社のリスト
から該当する会社を選択します。サイドバーで会社を選択し、会社名の下にある「API」を選択します。
「Webhookを管理する」の横にある
を選択し、Webhook リストを表示します。Webhookのステータスをオンまたはオフに変更します。
Webhookをオフにすると、そのWebhookに通知が送信されなくなります。
Webhookを削除する
Apple Business Connectにサインインしていない場合は、管理者の役割を持つユーザでサインインします。
複数の会社の管理者である場合は、会社のリスト
から該当する会社を選択します。サイドバーで会社を選択し、会社名の下にある「API」を選択します。
「Webhookを管理する」の横にある
を選択し、Webhook リストを表示します。Webhookを選択して下にスクロールし、「Webhookを削除」を選択します。
「削除」を選択し、「保存」を選択します。