API トリガーキャンペーン用のフィードバック Webhook の作成 webhooks

このページ: Adobe Journey Optimizer で、トランザクション API トリガーキャンペーンのメッセージステータス更新をリアルタイムでシステムに配信する、フィードバック webhook の作成および設定方法について説明します。

フィードバック Webhook を使用すると、トランザクション API トリガーキャンペーンを通じて送信されたメッセージに対して、リアルタイムのステータス更新を受け取ることができます。 Webhook を設定すると、配信の結果をシステムに直接自動的に受信できるようになり、モニタリング、ログ記録、自動処理が可能になります。

Webhook 設定は、管理/チャネル/フィードバック Webhook 設定​メニューから管理できます。

NOTE
組織 + サンドボックス​の組み合わせごとに、1 つの Webhook 設定のみが許可されます。

フィードバック Webhook の作成 feedback-webhook

Webhook を作成するには、次の手順に従います。

  1. 管理/チャネル/フィードバック Webhook 設定​に移動します。

  2. 「フィードバック Webhook を作成」をクリックします。

  3. 「基本設定」セクションで、次の詳細を指定します。

    • Webhook 名 - Webhook を識別するわかりやすい名前を入力します。
    • チャネル – このWebhookがフィードバックを受け取るチャネル(電子メールまたはモバイル)を選択します。
    • Webhook URL - フィードバックイベントを配信する必要がある HTTPS エンドポイントを指定します。
  4. 「認証」セクションで、認証方法を選択します。

    • 認証なし - 認証ヘッダーは追加されません。
    • JWT 認証 - エンドポイントで JWT 認証が必要な場合は、必要な詳細を指定します。
  5. 「ヘッダーパラメーター」セクションでは、各 Webhook リクエストと共に送信される追加のカスタムヘッダーを設定します。

  6. 「送信」をクリックして設定を保存します。

NOTE
Webhook はいつでも編集できます。 これを行うには、インベントリから開き、「編集」ボタンをクリックします。

Webhook ペイロード構造

メッセージの実行後、Journey Optimizer は次のペイロードを設定済みのエンドポイントに送信します。

messageExclusionなどのメッセージフィードバックイベントフィールドの定義については、Adobe Journey Optimizer スキーマ参照を参照してください。

ペイロードには、次のキャンペーンとモバイル配信の詳細が含まれます。

  • messageExecution.campaignType - キャンペーンの種類:ScheduledまたはApiTriggered。
  • messageDeliveryFeedback.encoding - GSMやUNICODEなど、プロバイダーから報告されたSMS エンコーディング。
  • messageDeliveryFeedback.numberOfMessageParts - メッセージが分割されたSMS部分(セグメント)の数。文字列として送信されます。
  • messageDeliveryFeedback.deliveryTimestamp - ISO-8601形式のプロバイダーが報告したイベント時間。
NOTE
現在、encoding、numberOfMessagePartsおよびdeliveryTimestamp フィールドは、Sinch SMS プロバイダーにのみ入力されています。 値のないフィールドはnullとして送信されます。

メールサンプルペイロード

{
  "requestId": "8NoByJneShCdCGRnrGS1t1m3CdA73dhR",
  "imsOrg": "myImsOrg",
  "sandbox": {
    "id": "068abf40-575e-11ea-8512-9b1bfdb82603",
    "name": "prod"
  },
  "channel": "email",
  "eventType": "message.feedback",
  "messageExecution": {
    "messageExecutionID": "HUMA-26362805",
    "messageType": "transactional",
    "campaignID": "16f24a15-7e21-477c-848a-d5695ca7f137",
    "campaignVersionID": "2ca10c10-56dd-4505-87cd-fa5da84e7a5d",
    "campaignType": "ApiTriggered"
  },
  "messageDeliveryFeedback": {
    "feedbackStatus": {
      "value": "bounce"
    },
    "offers": null,
    "messageExclusion": null,
    "messageFailure": {
      "category": "sync",
      "type": "Ignored",
      "code": "25",
      "reason": "Admin Failure"
    },
    "retryCount": 0,
    "encoding": null,
    "numberOfMessageParts": null,
    "deliveryTimestamp": null
  },
  "identityMap": {
    "email": [
      {
        "id": "john.doe@luma.com",
        "primary": true
      }
    ]
  }
}

SMS サンプルペイロード

次の例は、Sinchを通じて送信されたSMS メッセージの配信フィードバックを示しています。

{
  "requestId": "4f1c2d9e-...",
  "imsOrg": "XXXX@AdobeOrg",
  "sandbox": {
    "id": "...",
    "name": "prod"
  },
  "channel": "sms",
  "eventType": "message.feedback",
  "channelContext": {
    "profileAddress": null,
    "profileNumber": "+15555550123"
  },
  "messageExecution": {
    "messageExecutionID": "UMA-...",
    "messageType": "marketing",
    "campaignID": "...",
    "campaignVersionID": "...",
    "messageID": "...",
    "messageProfileID": "...",
    "campaignType": "ApiTriggered"
  },
  "messageDeliveryFeedback": {
    "feedbackStatus": {
      "value": "delivered"
    },
    "offers": null,
    "messageExclusion": null,
    "messageFailure": null,
    "retryCount": null,
    "responseCode": null,
    "responseDurationMillis": null,
    "encoding": "GSM",
    "numberOfMessageParts": "2",
    "deliveryTimestamp": "2026-10-06T18:22:41.512Z"
  },
  "identityMap": {
    "Phone": [
      {
        "id": "+15555550123"
      }
    ]
  }
}

Webhook は、次のイベントをキャプチャできます。

  • 送信済み
  • 配信済み
  • バウンス(上記の例を参照)
  • エラー

すべての受信リクエストには、Webhookに送り返される一意のrequestIdも含まれます。

次の手順 next

フィードバック Webhook が作成されると、トランザクション API トリガーキャンペーン​オーディエンスを設定する際にそれを有効にすることができます。 詳しくは、Webhook の有効化の節を参照してください

recommendation-more-help
journey-optimizer-help