イベントサブスクリプション

Integration Connectors によって、バックエンドで読み取りと書き込みのオペレーションを行えるだけでなく、バックエンドアプリケーションで発生したイベントをサブスクライブできます。たとえば、新しい Jira チケットが作成されたときに通知を受け取るとします。これは、イベントサブスクリプション用に Jira Cloud コネクタを構成することで実現できます。イベントサブスクリプションと Application Integration を併用することで、ビジネスニーズの対応に役立つ統合を作成できます。詳細については、統合でイベントサブスクリプションを使用するをご覧ください。

接続でイベントサブスクリプションを有効にする

作成した接続は、次のいずれかの目的で使用できます。

コネクタオペレーション（エンティティとアクション）の実行のみ
イベントサブスクリプションの場合のみ
コネクタオペレーションとイベントサブスクリプションを実行する場合

イベントサブスクリプションを有効にして、イベント関連の詳細を構成するオプションは、接続の作成中に使用できます。ただし、既存の接続がもうあり、それをイベントサブスクリプションに再利用する場合は、接続を編集して再構成します。

イベントサブスクリプションをサポートするコネクタは次のとおりです。

イベント通知のデータ拡充

イベント通知レスポンスに追加情報を追加するように接続を構成できます。追加情報は、イベントを構成したエンティティに固有のものです。追加情報を取得するには、接続でデータ拡充を有効にする必要があります。

たとえば、Zendesk でチケット作成イベントに登録した場合、チケットが作成されると通知されます。ただし、イベント通知ペイロードにはチケットの基本情報のみが含まれます。チケットの説明、割り当て先、ステータスなどの追加の詳細はペイロードに含まれません。ticket エンティティの追加の詳細を取得するには、Zendesk 接続でデータ拡充を有効にする必要があります。詳細については、イベントサブスクリプションの構成をご覧ください。次のサンプルは、データ拡充ありとなしのレスポンスペイロードを示しています。

データ拡充なしのペイロード

次のサンプルは、データ拡充なしの Zendesk チケット作成イベントのレスポンスペイロードを示しています。

{
  "account_id": 12345,
  "integration_key": "my_integration_key",
  "subdomain": "my_zendesk_subdomain",
  "input": {
    "ticket_event": {
      "meta": {
        "version": "1.0",
....
....
        "position": 1,
          "total": 9
        }
      },
      "type": "Ticket Created",
      "ticket": {
        "id": 35436,
....
....
        "external_id": "TEST1234",
        "tags": [
          "enterprise"
        ],
        "via": {
          "channel": "web"
        }
      }
    }
  }

データ拡充ありのペイロード

次のサンプルは、Zendesk のチケット作成イベントのレスポンスペイロードとデータ拡充を示しています。

{
    "context-data": {
    "AllowChannelback": false,
    "Assignee": null,
    "AssigneeId": 1.6696812051473E13,
    "Brand": null,
    "BrandId": 1.6696812163985E13,
    "Cc": null,
    "CollaboratorIds": null,
    "Commenter": null,
    "HasAttachment": null,
    "CreatedAt": "2023-07-08 11:37:19.0",
    "CustomFields": null,
    "Description": "Test desc 2",
....
....
    "Status": "open",
    "Subject": "Test Zendesk Ticket Created -2 -DA",
    "Submitter": null,
    "SubmitterId": 1.6696812051473E13,
    "Tags": "tag-changed-after-cache,ticket-created",
....
....
    "ViaChannel": "web",
    "ViaFollowupSourceId": null,
    "ViaSource": "{\r\n  \"from\": null,\r\n  \"to\": null,\r\n  \"rel\": null\r\n}",
    "View_Id": null
  },
   "data":{
  "account_id": 12345,
  "integration_key": "my_integration_key",
  "subdomain": "my_zendesk_subdomain",
  "input": {
    "ticket_event": {
      "meta": {
        "version": "1.0",
....
....
        "position": 1,
          "total": 9
        }
      },
      "type": "Ticket Created",
      "ticket": {
        "id": 35436,
....
....
        "external_id": "TEST1234",
        "tags": [
          "enterprise"
        ],
        "via": {
          "channel": "web"
        }
      }
    }
  }
 }

イベントサブスクリプションのプライベート接続

セキュリティを強化するため、バックエンドアプリケーションと接続の間にプライベート接続を構成できます。非公開接続では、接続のイベントリスナーは直接公開されません。代わりに、Integration Connectors から提供される PSC サービスアタッチメントを介したイベントリスナーへの上り（内向き）ネットワークトラフィックを許可する必要があります。

接続の作成中に、イベントサブスクリプションに [プライベート接続を有効にする] を選択した場合、Integration Connectors は PSC サービスアタッチメントを作成します。適切な方法を使用して、PSC サービスアタッチメントをバックエンドアプリケーションに公開する必要があります。考えられる 1 つのアプローチは、ロードバランサで PSC サービスアタッチメントを使用し、バックエンドアプリケーションからのイベントを受け入れるようにロードバランサを構成することです。この接続は、ロードバランサのアドレスでバックエンドのイベントをリッスンします。ロードバランサを使用してプライベート接続を構成する大まかな手順は次のとおりです。

新しく作成した接続の接続の詳細ページに移動します。
[上り（内向き）エンドポイントを編集] をクリックします。これにより、[イベントサブスクリプションの設定] ペインが表示されます。
[PSC サービスアタッチメント名] フィールドに表示されているサービスアタッチメント名をコピーします。
前の手順で取得したサービスアタッチメントを指す PSC ネットワークエンドポイントグループを作成します。
前の手順で作成した PSC ネットワークエンドポイントグループをバックエンドとして、外部ロードバランサを作成します。
ヒント: 外部ロードバランサがすでにある場合は、新しいロードバランサを作成する代わりに、そのロードバランサを使用してプライベート接続を構成できます。
イベントプロバイダ（バックエンドアプリケーション）の IP アドレスからのリクエストを受け入れるロードバランサを構成します。
後続のセット（7 ～ 11）は、バックエンドがイベントサブスクリプションの自動登録をサポートするコネクタにのみ適用されます。（例: Zendesk、Jira）。
新しく作成した接続の接続詳細ページに移動します。
[上り（内向き）エンドポイントを編集] をクリックします。[イベントサブスクリプションの設定] ペインが表示されます。
ロードバランサのアドレスを [イベントリスナー上り（内向き）エンドポイント] フィールドに入力します。
[完了] をクリックします。
[保存] をクリックして、接続への変更を保存します。

統合でイベントサブスクリプションを使用する

統合とともにイベントサブスクリプションを使用すると、複雑なビジネス上の問題を解決する統合を作成できます。たとえば、ServiceNow イベントに基づいて統合全体の実行を開始できます。Application Integration には、バックエンドアプリケーションからのイベント通知をリッスンする次のトリガーがあります。

HubSpot トリガー - HubSpot イベントをリッスンします。
IBM MQ トリガー - IBM MQ イベントをリッスンします。
Jira Cloud トリガー - Jira Cloud イベントをリッスンします。
Rabbit MQ トリガー - Rabbit MQ イベントをリッスンします。
ServiceNow トリガー - ServiceNow イベントをリッスンします。
TIBCOEMS トリガー - TIBCOEMS イベントをリッスンします。
Webhook トリガー - 一般的な Webhook イベントをリッスンします。
Zendesk トリガー - Zendesk イベントをリッスンします。

トリガーを構成するには、接続のイベントサブスクリプションを有効にする必要があります。イベントサブスクリプションは、既存の接続と新しい接続のずれかで有効にできます。これらの Application Integration トリガーを構成する方法の詳細手順については、対応するトリガーのドキュメントをご覧ください。

有効なサブスクリプションを表示

アプリケーション統合でイベントサブスクリプションを使用すると、Integration Connectors は対応する接続にサブスクリプションのエントリを作成します。接続のすべてのサブスクリプションを表示する手順は次のとおりです。

Google Cloud プロジェクトのすべての接続ページを開きます。
[接続] ページに移動
サブスクリプションを表示する接続をクリックします。
これにより、[接続の詳細] ページが開きます。
[サブスクリプション] タブをクリックします。
ここでは、接続のすべてのサブスクリプションが表示されます。このページに表示される定期購入は、次のいずれかのステータスになります。
- 作成 - 統合によってサブスクリプションを作成中です。
- 有効 - サブスクリプションは有効で機能しています。
- 一時停止 - 接続は一時停止状態です。
- エラー - サブスクリプションの作成に失敗しました。たとえば、サブスクリプションの作成中に認証が失敗した場合です。

イベントサブスクリプションの料金

プレビュートリガーでイベントサブスクリプションに対して処理されたデータ（イベントペイロード）は課金されません。ただし、一般提供されているトリガーで処理されたイベントサブスクリプションデータに対しては課金されます。

イベント サブスクリプション

接続でイベント サブスクリプションを有効にする