Webhookとは
ポーリングとWebhook
Webhookを使うと、アプリケーションがイベントをリアルタイムで受信して処理できます。 たとえば、サービスが新規登録を定期的に確認する方法をポーリングと呼びます。ポーリングでは次の確認まで登録を検知できません。Webhookなら登録時にイベントを受け取るため、すぐに処理できます。NotiflyのWebhook
Webhookは、条件を満たしたときにシステム間でメッセージを送る仕組みです。Notiflyでは、主に以下の条件で送信されます。- ユーザーの操作などでイベントが発生したとき
- 定期配信を含む予約配信の指定時刻になったとき
事前準備
-
Webhookを受信するサーバー
- インターネットからアクセスでき、HTTPリクエストを受け取れるサーバーを用意します。
- 指定したURLでNotiflyがサーバーにアクセスできるように、DNSを設定します。
-
NotiflyのIPアドレスの許可リスト
-
ネットワークポリシーで、NotiflyがWebhookを送信するサーバーからのアクセスを許可します。以下のIPアドレスを許可する前に、現在の送信元IPアドレスをNotiflyに確認してください。
3.38.74.15143.201.228.10343.200.138.23
-
ネットワークポリシーで、NotiflyがWebhookを送信するサーバーからのアクセスを許可します。以下のIPアドレスを許可する前に、現在の送信元IPアドレスをNotiflyに確認してください。
Webhookキャンペーンの作成とパーソナライズ
Webhookキャンペーンを作成する
Webhookキャンペーンを作成するには、以下の情報を入力します。リクエストにユーザーごとの情報を含める方法は、メッセージのパーソナライズを参照してください。
- Webhookを受け取るURLを入力します。この項目は必須です。
- HTTPメソッドを選択します。
GET、POST、PUT、DELETEに対応しています。 - Request Headers(リクエストヘッダー)に、各ヘッダーの名前と値を入力します。
- Request Body(リクエスト本文)に本文を入力します。
GETを選択すると、この項目は表示されません。
リクエストをパーソナライズする
Notiflyでは、メッセージのパーソナライズにLiquidテンプレート言語を使います。以下は、Webhookの本文にユーザー属性を挿入する例です。nameやemailがユーザー属性にない場合は、該当する値が空文字列になります。
JSON形式の本文を使う場合は、テンプレートの展開結果が有効なJSONになるようにしてください。Liquidのjsonフィルターを使うと、値をJSON形式に変換できます。
このテンプレートは、ユーザーの 以下はテンプレートは次のように出力されます。
properties を出力します。値がない場合は null を出力します。nameとpropertiesを持つテストデータです。propertiesの値が存在しない場合は、次のように展開されます。パーソナライズをテストする
- Liquid JS Playgroundで、テンプレートが期待どおりに展開されることを確認します。
-
Notiflyで、URLを入力してHTTPメソッドを選択します。必要に応じてヘッダーと本文を入力し、テスト送信をクリックします。

- テストに使う外部ユーザーID(ユーザー一覧のユーザーID)を入力し、送信をクリックします。Notiflyがそのユーザーのデータを使って、設定したURLにリクエストを送信します。
- 受信サーバーのログで、想定どおりのHTTPメソッド、ヘッダー、本文でリクエストが届いたことを確認します。
送信結果
- タイムアウトは5秒です。リクエストがタイムアウトすると、Notiflyは送信失敗として記録します。
- HTTPステータスコードが2xxの場合は送信成功、それ以外は送信失敗として記録されます。
