> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhookでリクエストを送信する

> Webhookキャンペーンを設定し、Liquidを使ってリクエストにユーザーごとの情報を入れます。

## Webhookとは

### ポーリングとWebhook

Webhookを使うと、アプリケーションがイベントをリアルタイムで受信して処理できます。

たとえば、サービスが新規登録を定期的に確認する方法をポーリングと呼びます。ポーリングでは次の確認まで登録を検知できません。Webhookなら登録時にイベントを受け取るため、すぐに処理できます。

### NotiflyのWebhook

Webhookは、条件を満たしたときにシステム間でメッセージを送る仕組みです。Notiflyでは、主に以下の条件で送信されます。

* ユーザーの操作などでイベントが発生したとき
* 定期配信を含む予約配信の指定時刻になったとき

条件を満たすと、Notiflyは指定したURLにHTTPリクエストを送ります。リクエストには設定したメソッド、ヘッダー、本文を使います。

## 事前準備

1. Webhookを受信するサーバー

   * インターネットからアクセスでき、HTTPリクエストを受け取れるサーバーを用意します。
   * 指定したURLでNotiflyがサーバーにアクセスできるように、DNSを設定します。

2. NotiflyのIPアドレスの許可リスト

   * ネットワークポリシーで、NotiflyがWebhookを送信するサーバーからのアクセスを許可します。以下のIPアドレスを許可する前に、現在の送信元IPアドレスをNotiflyに確認してください。

     * `3.38.74.151`
     * `43.201.228.103`
     * `43.200.138.23`

## Webhookキャンペーンの作成とパーソナライズ

### Webhookキャンペーンを作成する

Webhookキャンペーンを作成するには、以下の情報を入力します。リクエストにユーザーごとの情報を含める方法は、[メッセージのパーソナライズ](https://docs.notifly.tech/ja/user-guide/campaigns/personalization/basic.md)を参照してください。

![Webhookリクエストの設定画面](https://mintcdn.com/notifly/ZSWJJOaZ4UmG3tpK/images/i18n/ja/webhook/webhook-message-1.png?fit=max\&auto=format\&n=ZSWJJOaZ4UmG3tpK\&q=85\&s=cdd024f46885dbc7f4914bc8a18e4229)

* Webhookを受け取るURLを入力します。この項目は必須です。
* HTTPメソッドを選択します。`GET`、`POST`、`PUT`、`DELETE`に対応しています。
* **Request Headers**（リクエストヘッダー）に、各ヘッダーの名前と値を入力します。
* **Request Body**（リクエスト本文）に本文を入力します。`GET`を選択すると、この項目は表示されません。

> [!WARNING]
>
> Webhookチャネルでは、端末情報を使ったパーソナライズに対応していません。

### リクエストをパーソナライズする

Notiflyでは、メッセージのパーソナライズに[Liquidテンプレート言語](https://liquidjs.com/tutorials/intro-to-liquid.html)を使います。以下は、Webhookの本文にユーザー属性を挿入する例です。

```
{
  "name": {{ user['name'] | default: "" | append: "" | json }},
  "email": {{ user['email'] | default: "" | append: "" | json }}
}
```

`name`や`email`がユーザー属性にない場合は、該当する値が空文字列になります。

JSON形式の本文を使う場合は、テンプレートの展開結果が有効なJSONになるようにしてください。Liquidの[`json`フィルター](https://shopify.dev/docs/api/liquid/filters/json)を使うと、値をJSON形式に変換できます。

> [!TIP]
>
> このテンプレートは、ユーザーの `properties` を出力します。値がない場合は `null` を出力します。
>
> ```
> {%- assign additional_properties = user["properties"] -%}{%- if additional_properties -%}{  "name": {{ user["name"] | default: "" | json }},  "properties": {{ user["properties"] | json }}}{%- else -%}{  "name": {{ user["name"] | default: "" | json }},  "properties": null}{%- endif -%}
> ```
>
> 以下は`name`と`properties`を持つテストデータです。
>
> ```
> {  "name": "John Doe",  "properties": {    "age": 30  }}
> ```
>
> テンプレートは次のように出力されます。
>
> ```
> {  "name": "John Doe",  "properties": {    "age": 30  }}
> ```
>
> `properties`の値が存在しない場合は、次のように展開されます。
>
> ```
> {  "name": "John Doe",  "properties": null}
> ```

### パーソナライズをテストする

1. [Liquid JS Playground](https://liquidjs.com/playground.html)で、テンプレートが期待どおりに展開されることを確認します。

2. Notiflyで、URLを入力してHTTPメソッドを選択します。必要に応じてヘッダーと本文を入力し、**テスト送信**をクリックします。

   ![Webhookキャンペーンの作成画面にあるテスト送信ボタン](https://mintcdn.com/notifly/ZSWJJOaZ4UmG3tpK/images/i18n/ja/webhook/webhook-test-1.png?fit=max\&auto=format\&n=ZSWJJOaZ4UmG3tpK\&q=85\&s=add021ebdd36b2e0eb0d7cf52acf3055)

3. テストに使う外部ユーザーID（ユーザー一覧の**ユーザーID**）を入力し、**送信**をクリックします。Notiflyがそのユーザーのデータを使って、設定したURLにリクエストを送信します。

4. 受信サーバーのログで、想定どおりのHTTPメソッド、ヘッダー、本文でリクエストが届いたことを確認します。

## 送信結果

1. タイムアウトは5秒です。リクエストがタイムアウトすると、Notiflyは送信失敗として記録します。
2. HTTPステータスコードが2xxの場合は送信成功、それ以外は送信失敗として記録されます。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.