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