管理メニュー「Webhook」をクリックすると、Webhook画面が表示されます。
Webhookを使うと、Platioアプリで何かイベントが発生したときに他のアプリケーションにリアルタイムで情報を送信することができます。
Webhookについては開発者ドキュメント「Webhook プログラミングガイド」を参照してください。ここでは、Webhook画面について説明します。
①追加
Webhookを追加します。クリックすると、Webhookの追加画面が表示されます。
②削除
選択したWebhookを削除します。
③Webhookメニュー
クリックするとメニューが表示されます。
Webhookをインポート
複数のWebhookをあらかじめ用意したCSVファイルで一括でインポートします。詳しくは後述の「Webhookをインポート」を参照してください。
Webhookをエクスポート
Webhookの一覧をCSVファイルにエクスポートします。詳しくは後述の「Webhookをエクスポート」を参照してください。
④検索
Webhook名を入力して検索アイコンをクリックすると絞り込み表示されます。
⑤呼び出し回数
現在の時間枠内の呼び出し回数が表示されます。
呼び出し回数については、開発者ドキュメントの「制限」を参照してください。
⑥Webhook数
ご契約のWebhook数のうち、作成したWebhook数が確認できます。
⑦Webhook一覧
Webhookの一覧が表示されます。Webhook情報を確認できます。
アイコンをクリックすると項目でソートして表示されます。クリックする度に昇順と降順に切り替わります。
⑧編集
このWebhookの情報を編集します。クリックすると編集画面が表示されます。
⑨選択
Webhookを選択します。ヘッダー行を選択するとページに表示されているWebhookをまとめて選択できます。
⑩ログ
Webhookのログを表示します。ログの形式は、ガイド「処理ログ」の「ログ画面」を参照してください。
Webhookの追加
「追加」をクリックし、Webhookの追加画面でWebhook情報を入力します。
名前
Webhook名を指定します。
データポケット
対象のデータポケットを指定します。
モード
Webhookのモードを下記から指定します。「順序保証」は、契約プランがPremium/Enterpriseの場合に利用できます。
クイック／順序保証
モードについては、開発者ドキュメントの「モードとエラー処理」を参照してください。
イベント
Webhookの通知を送るイベントを下記から指定します。
レコードの挿入／レコードの更新／レコードの削除
URL
URLを指定します。
HTTPメソッド
HTTPメソッドを下記から指定します。
メソッドについては、開発者ドキュメントの「GETでの通知」を参照してください。
POST／GET
タイプ
タイプを下記から指定します。
タイプについては、開発者ドキュメントの「フォームデータでの通知」を参照してください。
JSON／フォームデータ
変換
リクエスト本体の変換を指定します。変換はPlatio式で指定します。
変換については、開発者ドキュメントの「リクエスト本体の変換」を参照してください。
条件
特定の条件を満たした場合だけ、リクエストを送ることができます。条件はPlatio式で指定します。
条件については、開発者ドキュメントの「リクエストの条件」を参照してください。
Basic認証
Webhookの設定ごとにBasic認証を指定します。
オンにすると、ユーザー名とパスワードが表示されます。認証のユーザー名とパスワードを指定します。
ヘッダー
送信するヘッダーを最大５個追加できます。追加する場合は「＋」アイコンをクリックします。削除する場合はゴミ箱アイコンをクリックします。
通知メール
エラーによってこのWebhookが無効になったときに、指定されたメールアドレスに通知を送ります。メールアドレスは５個まで指定できます。
この機能は、契約プランがPremium/Enterpriseの場合に利用できます。
Webhookの編集
「編集」をクリックし、編集画面でWebhook情報を編集します。
データポケットとモードは変更できません。各設定については、前述の「Webhookの追加」を参照してください。
状態
Webhookが有効か無効かを指定します。
ログ
このWebhookのログを表示します。ログの形式は、ガイド「処理ログ」の「ログ画面」を参照してください。
Webhookをインポート
事前に必要なWebhook情報を指定したCSVファイルを用意してインポートすると、複数のWebhookを一括で追加することができます。
Webhookメニューで「Webhookをインポート」をクリックし、「Webhookのインポート」画面で示されたフォーマットを参照し、CSVファイルを事前に作成してインポートします。
「必要な列」は、インポートするときの必須項目です。必ず指定してください。
name：Webhook名
collection：データポケット名
mode：モード（quickまたはstrict）
url：URL
httpMethod：HTTPメソッド（POSTまたはGET）
httpPostType：タイプ（application/jsonまたはapplication/x-www-form-urlencoded）
transform：変換
「任意な列」は、必須ではありません。
recordInsertEvent：レコードの挿入（チェックがオンの場合はtrue、オフの場合はfalse）
recordUpdateEvent：レコードの更新（チェックがオンの場合はtrue、オフの場合はfalse）
recordDeleteEvent：レコードの削除（チェックがオンの場合はtrue、オフの場合はfalse）
condition：条件
header1：ヘッダー
header2：ヘッダー
header3：ヘッダー
header4：ヘッダー
header5：ヘッダー
disabled：状態（有効の場合はfalse、無効の場合はtrue）
notificationEmailAddresses：通知メールアドレス
インポートするファイル
「参照」をクリックし、用意したCSVファイルを指定します。
エンコーディング
ファイルのエンコーディングで「UTF-8」または「Shift JIS(CP932)」を指定します。
Basic認証
Basic認証を指定する場合、header列にauthorizationヘッダーとして記述します。
Webhookをエクスポート
Webhookメニューで「Webhookをエクスポート」をクリックすると、Webhookの一覧を「webhooks.csv」というファイル名（エンコーディングはUTF-8）のCSVファイルで自動ダウンロードされます。
CSVファイルには以下のフィールドでWebhook情報がエクスポートされます。
name：Webhook名
collection：データポケット名
mode：モード（quickまたはstrict）
recordInsertEvent：レコードの挿入（チェックがオンの場合はtrue、オフの場合はfalse）
recordUpdateEvent：レコードの更新（チェックがオンの場合はtrue、オフの場合はfalse）
recordDeleteEvent：レコードの削除（チェックがオンの場合はtrue、オフの場合はfalse）
url：URL
httpMethod：HTTPメソッド（POSTまたはGET）
httpPostType：タイプ（application/jsonまたはapplication/x-www-form-urlencoded）
transform：変換
condition：条件
header1：ヘッダー
header2：ヘッダー
header3：ヘッダー
header4：ヘッダー
header5：ヘッダー
disabled：状態（有効の場合はfalse、無効の場合はtrue）
notificationEmailAddresses：通知メールアドレス
Basic認証
Basic認証が指定されている場合、header列にauthorizationヘッダーの内容が出力されます。