ブログに戻る

最初の Webhook URL を作成する

最初の Webhook URL を作成する

新しい Webhook を作成する

Webhook の作成

  1. Webhooks ページにアクセスします
  2. 「Create」ボタンをクリックします
  3. フォームに次の情報を入力します
    • Name: Webhook の名前
    • Application: Webhook を紐付けるアプリケーション
    • Device: Webhook を紐付けるデバイス
    • Message: Webhook がトリガーされたときに送信するメッセージ
  4. 「Create」ボタンをクリックします
  5. Webhook の URL をコピーします

メッセージに * を指定すると、JSON をすべて取得し、必要なパラメータを判断できます。

JSON パーサーの仕組み

Webhook は、アプリケーション間でリアルタイムにデータを送信するために欠かせない仕組みです。次の手順に従って Webhook を効率よく設定し、システムとのスムーズな連携を実現しましょう。

  1. JSON ペイロードの構造を定義する
    受け取りたいデータの形式を確認します。データセット全体を取得するには、設定でワイルドカード記号 * を使用します。これにより、フィルタリングされずに JSON ペイロード全体が配信されます。
  2. ネストされた JSON から特定のデータを抽出する
    ネストされたオブジェクト内の個別のフィールドを指定するには、%objectName.field% の構文を使用します。たとえば、%params.name% は params オブジェクトから name の値を抽出します。
{
  "event": {
    "title": "New Order",
    "message": "A new order has been placed with ID 12345",
    "tags": ["order", "new"],
    "users": [
      {"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]},
      {"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]},
      {"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]}
    ]
  }
}

Webhook を設定するには、次のように構成します。

  • JSON 全体を表示したい場合は、単に * を使用します
  • イベントのタイトルを取得するには、%event.title% を使用します
  • メッセージを取得するには、%event.message% を使用します
  • タグを取得するには、%event.tags% を使用します
Title: %event.title%
Message: %event.message%
Tags: %event.tags%
Users: %event.users.0%
First user: %event.users.0.first% %event.users.0.last%

上記の JSON の例に基づいて、この設定を使用した場合の出力は次のようになります。

Title: New Order
Message: A new order has been placed with ID 12345
Tags: ["order","new"]
Users: {"age":44,"first":"Dale","last":"Murphy","nets":["ig","fb","tw"]}
First user: Dale Murphy

変数の詳細については、GJSON Path Syntax を参照してください。

この記事をシェア