Webhookコネクタの構成ガイド

Webhookコネクタについて

Webhookコネクタを使用すると、カスタマイズされたHTTPリクエストを使用してベンダーにデータを送信できます。URL、URLパラメータ、ヘッダー、クッキー、ボディのコンテンツタイプ、およびボディデータなど、HTTPリクエストのすべての側面を制御できます。Webhookは、バッチ処理と複雑で動的なデータ形式を処理するために設計された強力なテンプレート機能もサポートしています。

ベンダーの認証要件に基づいて、次の3つのWebhookコネクタから選択できます。

• Webhook（BasicAuth）- 認証が不要またはユーザー名とパスワードの基本認証のみが必要なサービスに使用します。
• Webhook OAuth2（3-Legged）- ユーザーがサービスにログインしてアクセストークンを取得する必要があります。
• Webhook OAuth2（2-Legged）- ユーザーがサービスにログインする必要はありません。Webhookは、認証に必要な情報で構成されます。

Webhook OAuth2は、明示的にOAuth 2.0認証が必要なサービスに使用されます。

始めるには、コネクタマーケットプレイスに移動し、使用するWebhookインスタンスを追加します。コネクタを追加する方法の一般的な手順については、コネクタの概要を参照してください。

以下のセクションでは、各タイプのWebhookコネクタの構成方法について説明します。

Webhook（BasicAuth）の構成

このWebhookは、HTTPヘッダーフィールドAuthorizationを使用した基本的なHTTP認証をサポートしています。認証情報は、Base64エンコードされた文字列{username}:{password}として渡されます。

BasicAuth Webhookの構成には、次の構成を使用します。

• タイトル
  • 必須
  • Webhookの説明的なタイトルを入力します。
• BasicAuthユーザー名
  • Webhookの認証のユーザー名を入力します。
• BasicAuthパスワード
  • Webhookの認証のパスワードを入力します。

次へをクリックするか、アクションタブに移動します。

• アクションタブを使用して、トリガーするHTTPリクエストを構成します。

Webhook OAuth2（3-Legged）の構成

WebhookのOAuth実装は、サーバーサイドアプリケーションのみをサポートしています。

OAuth 2.0サービスでWebアプリケーションを登録してください。アプリケーションは、https://my.tealiumiq.com/oauth/webhook/callback.htmlというリダイレクトURLを許可するように構成する必要があります。

OAuth2（3-legged）Webhookの構成には、次の構成を使用します。

• クライアントID
  • 必須
  • OAuthサービスから割り当てられたクライアント識別子を入力します。
• クライアントシークレット
  • 必須
  • OAuthサービスから割り当てられたクライアントシークレットを入力します。
• スコープ
  • アプリケーションへのアクセスを要求するための許可の種類を選択します。
• 認証URL
  • 必須
  • 認証後にユーザーをリダイレクトするURLを入力します。
• 認証URLクエリパラメータ
  • 認証URLの名前と値のペアを1つ以上選択します。
  • アンパサンド（&）を使用して複数のペアを区切ります。
  • 先頭にアンパサンド（&）を使用しないでください。
    • 正しい例：access_type=offline&prompt=consent
    • 間違った例：&access_type=offline&prompt=consent
• アクセストークンURL
  • 必須
  • リフレッシュトークンを取得するためのトークンURLを入力します。

接続を確立するをクリックして接続をテストします。

Webhook OAuth2（2-Legged）の構成

TealiumのWebhook OAuth2コネクタを使用すると、OAuth2 Two-Legged認証が必要な選択したAPIに対して、HTTPリクエストとして完全にカスタマイズされたデータを送信できます。クライアント資格情報とリソースオーナーパスワード資格情報の両方をサポートしています。

コネクタを追加した後、OAuth2 2-Legged Webhookの構成には、次の構成を使用します。

• アクセストークンURL
  • 必須
  • アクセストークンを要求するためのAPIエンドポイントURLを入力します。
• クライアントID
  • 必須
  • WebアプリケーションのクライアントIDを入力します。
• クライアントシークレット
  • 必須
  • Webアプリケーションのクライアントシークレットを入力します。
• ユーザー名
  • ユーザー名を入力します。
  • パスワードグラントタイプを使用する場合は、ユーザー名が必要です。
• パスワード
  • パスワードを入力します。
  • パスワードグラントタイプを使用する場合は、パスワードが必要です。
• スコープ
  • 要求するアクセス許可のスコープを選択します（一部のOAuth2サービスにのみ必要）。
• 追加の認証パラメータ
  • 追加の認証パラメータを追加します（一部のOAuth2サービスにのみ必要）。
  • 複数のパラメータを&で区切ります。
• 認証トークンの場所
  • 認証トークンを配置する場所を指定します。
• 認証ヘッダーの接頭辞
  • デフォルト値はBearerです。
  • 上書きするための新しい値を指定します（一部のOAuth2サービスにのみ必要）。

すべてのWebhookアクションのアクションパラメータ

次のパラメータは、すべてのWebhookアクションで使用できます。

入力フィールド	必須/オプション	テンプレートサポート	ノート
メソッド	必須		次のメソッドをサポートしています： GET POST PUT DELETE PATCH
URL	必須	✔	リクエストを送信するURLを指定します。
URLパラメータ	オプション	✔	マップドロップダウンリストから、送信する属性の値を選択します。 Toフィールドに、構成するURLパラメータの名前を入力します。
ヘッダー	オプション	✔	マップドロップダウンリストから、送信する属性の値を選択します。 Toフィールドに、値を受け取るヘッダーのヘッダー名を入力します。
クッキー	オプション	✔	マップドロップダウンリストから、送信する属性の値を選択します。 Toフィールドに、値を受け取るクッキーのクッキー名を入力します。
ボディコンテンツタイプ	オプション		Content-Typeヘッダーを指定します。 すべてのタイプはUTF-8文字セットを使用します。 GETメソッドではこの構成を無視します。
ボディデータ	オプション	✔	カスタムデータをHTTPリクエスト経由で送信するアクションでのみサポートされます GETメソッドではこの構成を無視します。 ボディコンテンツタイプがapplication/x-www-form-urlencodedの場合は、名前/値のペアを指定します より複雑なペイロードの場合は、テンプレート名を指定します。
バッチオプション	オプション	✔	レコード数の最大値は10から10,000です。 有効期間は5から60分です。
テンプレート変数	オプション		テンプレート変数ガイドを参照してください。
テンプレート	オプション		Trimouテンプレートガイドを参照してください。 各テンプレートには一意の名前が必要です テンプレートは、二重の中括弧で囲まれた名前を参照して、サポートされるフィールドに挿入されます テンプレートはURL、URLパラメータ、ヘッダー、クッキー、またはボディデータフィールドに挿入できます

テンプレートサポートに関する注意: カスタムテンプレートのフィールド値を入力するために、その名前を二重の中括弧で囲んで参照します。たとえば、テンプレートの名前がsome-templateである場合、レンダリングされたコンテンツは、フィールドに挿入するために{{some-template}}を参照することで注入されます。

要件

• イベントデータのために有効化されたTealiumアカウント（イベントデータ用）
• 訪問データのために有効化されたTealiumアカウント（訪問データ用）

コネクタアクション

アクション名	説明	Webhook（BasicAuth）	Webhook OAuth2
イベントデータをHTTPリクエストで送信する	イベントオブジェクト全体をURLエンコードされたJSON文字列またはJSONペイロードとして送信します。	✓	✗
訪問データをHTTPリクエストで送信する	訪問プロファイルオブジェクト全体をURLエンコードされたJSON文字列またはJSONペイロードとして送信します。	✓	✗
カスタマイズされたデータをHTTPリクエストで送信する（高度）	マッピングで指定された個々のイベント/訪問属性を送信します	✓	✓
バッチ処理されたカスタマイズされたデータをHTTPリクエストで送信する（高度）	マッピングで指定されたバッチ処理されたイベント/訪問属性を送信します。	✓	✓

構成の構成

コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法の一般的な手順については、コネクタの概要の記事を読んでください。

コネクタを追加した後、次の構成を構成します。

• 基本認証

  • ユーザー名（オプション）
  • 基本認証がAPIエンドポイントで必要な場合は、ユーザー名を入力します。

• 基本認証

  • パスワード（オプション）
  • 基本認証がAPIエンドポイントで必要な場合は、パスワードを入力します。

アクション構成 - パラメータとオプション

次へをクリックするか、アクションタブに移動します。ここでコネクタアクションを構成します。

このセクションでは、各アクションのパラメータとオプションの構成方法について説明します。

アクション - イベントデータをHTTPリクエストで送信する

パラメータ

パラメータ	説明
メソッド	必須：リクエストメソッドを選択します。 GETが選択された場合、イベントデータはJSON URLエンコードされたクエリ文字列パラメータとしてdataキーで送信されます。
URL	必須。 リクエストを送信するURLを指定します。 テンプレートサポート：テンプレートからURLを生成するためにテンプレート名を参照します。
URLパラメータ	オプション。 URLに追加するパラメータを指定します。 テンプレートサポート：テンプレートからパラメータ値を生成するためにテンプレート名を参照します。
ヘッダー	オプション。 HTTPヘッダーの値をヘッダー名にマッピングします。 テンプレートサポート：テンプレートからヘッダー値を生成するためにテンプレート名を参照します。
クッキー	オプション。 クッキーの値をクッキー名にマッピングします。 クッキーは単一のHTTPヘッダー値として追加されます。例：Cookie: name1=value1; name2=value2 テンプレートサポート：テンプレートからクッキーの値を生成するためにテンプレート名を参照します。
ボディコンテンツタイプ	オプション。 利用可能なタイプを選択するか、カスタム値を指定します。 すべてのタイプはUTF-8でエンコードされ、ヘッダーとして追加されます。例：Content-Type: text/plain; charset=UTF-8 ボディデータが提供される場合は、コンテンツタイプが必要です。
テンプレート変数	オプション。 テンプレート変数をテンプレートのデータ入力として提供します。詳細については、テンプレート変数ガイドを参照してください。 ネストされたテンプレート変数は、ドット表記法で名前を付けます。例：items.name ネストされたテンプレート変数は、通常、データレイヤーリスト属性から構築されます。
テンプレート	オプション。 URL、URLパラメータ、ヘッダー、またはボディデータのいずれかに挿入するために参照されるテンプレートを提供します。詳細については、テンプレートガイドを参照してください。 テンプレートは、二重の中括弧で囲まれた名前を参照して挿入されます。例：{{SomeTemplateName}} OAuthを使用する場合、テンプレート変数{{webhook_access_token}}は、認証リクエストで返されるトークンを参照します。

アクション - 訪問データをHTTPリクエストで送信する

パラメータ

パラメータ	説明
メソッド	必須 リクエストメソッドを選択します。 GETが選択された場合、訪問データはJSON URLエンコードされたクエリ文字列パラメータとしてdataキーで送信されます。
URL	必須。 リクエストを送信するURLを指定します。 テンプレートサポート：テンプレートからURLを生成するためにテンプレート名を参照します。
URLパラメータ	オプション。 URLに追加するパラメータを指定します。 テンプレートサポート：テンプレートからパラメータ値を生成するためにテンプレート名を参照します。
ヘッダー	オプション。 HTTPヘッダーの値をヘッダー名にマッピングします。 テンプレートサポート：テンプレートからヘッダー値を生成するためにテンプレート名を参照します。
クッキー	オプション。 クッキーの値をクッキー名にマッピングします。 クッキーは単一のHTTPヘッダー値として追加されます。例：Cookie: name1=value1; name2=value2 テンプレートサポート：テンプレートからクッキーの値を生成するためにテンプレート名を参照します。
ボディコンテンツタイプ	オプション。 利用可能なタイプを選択するか、カスタム値を指定します。 すべてのタイプはUTF-8でエンコードされ、ヘッダーとして追加されます。例：Content-Type: text/plain; charset=UTF-8 ボディデータが提供される場合は、コンテンツタイプが必要です。
テンプレート変数	オプション。 テンプレート変数をテンプレートのデータ入力として提供します。詳細については、テンプレート変数ガイドを参照してください。 ネストされたテンプレート変数は、ドット表記法で名前を付けます。例：items.name ネストされたテンプレート変数は、通常、データレイヤーリスト属性から構築されます。
テンプレート	オプション。 URL、URLパラメータ、ヘッダー、またはボディデータのいずれかに挿入するために参照されるテンプレートを提供します。詳細については、テンプレートガイドを参照してください。 テンプレートは、二重の中括弧で囲まれた名前を参照して挿入されます。例：{{SomeTemplateName}} OAuthを使用する場合、テンプレート変数{{webhook_access_token}}は、認証リクエストで返されるトークンを参照します。

アクション - カスタマイズされたデータをHTTPリクエストで送信する（高度）

パラメータ

パラメータ	説明
メソッド	必須。 詳細については、Webhookカスタムリクエストガイドを参照してください。 リクエストメソッドを選択します。
URL	必須。 リクエストを送信するURLを指定します。 テンプレートサポート：テンプレートからURLを生成するためにテンプレート名を参照します。
URLパラメータ	オプション。 URLに追加するパラメータを指定します。 テンプレートサポート：テンプレートからパラメータ値を生成するためにテンプレート名を参照します。
ヘッダー	オプション。 HTTPヘッダーの値をヘッダー名にマッピングします。 テンプレートサポート：テンプレートからヘッダー値を生成するためにテンプレート名を参照します。
クッキー	オプション。 クッキーの値をクッキー名にマッピングします。 クッキーは単一のHTTPヘッダー値として追加されます。例：Cookie: name1=value1; name2=value2 テンプレートサポート：テンプレートからクッキーの値を生成するためにテンプレート名を参照します。
ボディコンテンツタイプ	オプション。 利用可能なタイプを選択するか、カスタム値を指定します。 すべてのタイプはUTF-8でエンコードされ、ヘッダーとして追加されます。例：Content-Type: text/plain; charset=UTF-8 ボディデータが提供される場合は、コンテンツタイプが必要です。
ボディデータ	オプション。 メッセージボディを構築するためのデータを提供します。 テンプレートサポート：テンプレートからボディデータを生成するためにテンプレート名を参照します。 ボディコンテンツタイプがmultipart/form-dataまたはapplication/x-www-form-urlencodedの場合は、値を名前にマッピングします。それ以外の場合は、テンプレート名を参照してボディオプションのみを選択します。
テンプレート変数	オプション。 テンプレート変数をテンプレートのデータ入力として提供します。詳細については、テンプレート変数ガイドを参照してください。 ネストされたテンプレート変数は、ドット表記法で名前を付けます。例：items.name ネストされたテンプレート変数は、通常、データレイヤーリスト属性から構築されます。
テンプレート	オプション。 URL、URLパラメータ、ヘッダー、またはボディデータのいずれかに挿入するために参照されるテンプレートを提供します。詳細については、テンプレートガイドを参照してください。 テンプレートは、二重の中括弧で囲まれた名前を参照して挿入されます。例：{{SomeTemplateName}} OAuthを使用する場合、テンプレート変数{{webhook_access_token}} は、認証リクエストで返されるトークンを参照します。

アクション - バッチ処理されたカスタマイズされたデータをHTTPリクエストで送信する（高度）

バッチ制限

このアクションは、ベンダーへの高容量データ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値が満たされるか、プロファイルが公開されるまでキューに入れられます。

• 最大リクエスト数：100
• 最も古いリクエストからの経過時間の最大値：60分
• リクエストの最大サイズ：16 MB

パラメータ

パラメータ	説明
メソッド	必須。 詳細については、Webhookカスタムリクエストガイドを参照してください。 リクエストメソッドを選択します。
URL	必須。 リクエストを送信するURLを指定します。 テンプレートサポート：テンプレートからURLを生成するためにテンプレート名を参照します。
ボディコンテンツタイプ	オプション。 利用可能なタイプを選択するか、カスタム値を指定します。 すべてのタイプはUTF-8でエンコードされ、ヘッダーとして追加されます。例：Content-Type: text/plain; charset=UTF-8 ボディデータが提供される場合は、コンテンツタ