REST API トリガー

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：6分

    • 受信 API 呼び出しからフローを開始するか、外部システムから Webhook を開始します。カスタムコードを記述または管理する必要なく、トリガー開始条件を構成します。

    たとえば、サードパーティの IT チケット追跡システムがインスタンスに受信要求を送信したときに開始するフローを作成できます。その後、受信 REST 要求からのデータを解析して複合データオブジェクトにし、その値を使用してインスタンスでインシデントを開くことができます。

    フローを有効にすると、作成したエンドポイントが作成した名前空間の API Explorer に表示されます。このページを使用して、サードパーティシステムで Webhook を定義したり、フローをテストしたりすることができます。

    フロートリガーの詳細については、次を参照してください。 ワークフロースタジオ トリガータイプ.

    注:
    • REST API トリガーを使用して、外部システムからの REST コールからフローを開始します。同じインスタンスからスクリプトまたは API コールからフローを開始するには、サブフロー、コードスニペット、または ワークフロースタジオ API を使用します。「」を参照してください。 ワークフロースタジオへの API アクセス フロー 、サブフロー、およびアクションのコードスニペットを作成します。

    • ServiceNow は Boomi と提携し、顧客が API を検出、管理、保護、収益化できるようにするクラウドベースのプラットフォームである Boomi API Management を提供しています。Boomi は、ガバナンス、アナリティクス、API セキュリティを含むライフサイクル全体の API 管理をサポートします。

      Boomi は独自のポータルを通じてドキュメントを提供し、Boomi API Management のサポートを要求する顧客は、標準チャネルを通じて Boomi サポートに連絡します。

      開始するには、 Boomi API Management リストを参照してください ServiceNow® Storeには、エンタイトルメントと必要なプラグインに関する情報と、 Boomi API Management ドキュメント.

    利用可能なデータピル

    エンドポイントの構成方法に応じて、フロー設計者はトリガーから次のデータピルにアクセスできます。

    パスパラメーター
    受信要求内のパスパラメーターを含むオブジェクト。
    クエリパラメーター
    受信要求内のクエリパラメーターを含むオブジェクト。
    要求ヘッダー
    受信要求内のヘッダーを含むオブジェクト。
    要求本文
    受信要求の本文構造を定義する複合データオブジェクト。複合オブジェクトの詳細については、「Complex data」を参照してください。

    トリガーを設定するときは、受信データがどのようになるかを定義します。その後、フロー内のアクション内で関連付けられたデータピルを使用できます。システムがフローを開始する受信要求を受信すると、要求で送信されたランタイム値を使用します。

    REST API トリガーを使用してフローを作成する

    サードパーティシステムが REST 要求をインスタンスに送信したときに開始するフローを作成します。

    始める前に

    必要なロール：flow_designer または admin

    この機能には、統合ハブ サブスクリプションが必要です。詳細については「Legal schedules - IntegrationHub overview (法務スケジュール - 統合ハブの概要)」を参照してください。

    手順

    1. ワークフロースタジオ を開き、フローを作成します。

      「Create a flow (フローの作成)」を参照してください。

      フローのスコープは、作成する REST エンドポイントに含まれていることに注意してください。

    2. [トリガー] セクションで、[REST API - 非同期] トリガーを選択します。
    3. [HTTP メソッド] フィールドで、エンドポイントの HTTP メソッドを設定します。
      次のオプションが含まれます。
      • POST
      • GET
      • 消去
      • PUT
      • パッチ
    4. エンドポイントに必要なパスパラメーターを作成し、それらを [パス] フィールドの相対パスに追加します。
      エンドポイントへの相対パスの形式は、/api/<flow-application-scope>/<flow-name>/<path-parameters> です。

      [コピー] をクリックすると、完全パスをエンドポイントにコピーできます。サードパーティシステムで REST 呼び出しのエンドポイントを設定する場合は、このパスを使用します。

      1. [パスパラメーター] セクションで変数を作成します。
      2. パスパラメーターを表すデータピルを [パス] フィールドの空の入力にドラッグします。

        このフィールドは、[パスパラメーター] セクションからのデータピルのみを受け入れます。

    5. 受信 REST 要求で認証ヘッダーを要求するには、[認証が必要] を選択します。
    6. [認証が必要] が選択されている場合は、要求を許可するために必要なロールを [ロールが必要] フィールドに追加します。
    7. [要求コンテンツ] セクションの [本文] フィールドで、受信要求の本文構造を定義する複合データオブジェクトを作成します。

      複合オブジェクトのビルドの詳細については、「複合データ」を参照してください。

      注:
      [コンテンツの要求] セクションは、[HTTP メソッド] が POST、PUT、または PATCH の場合にのみ表示されます。

      このサンプル本文では、受信ペイロードの [説明] フィールドにサードパーティのチケット追跡システムからのチケット情報が含まれています。

    8. [ヘッダー] フィールドで、受信要求で送信されるヘッダーを定義します。
      受信要求にそれらを含めるように要求するには、[必須] を選択します。
    9. [クエリパラメーター] フィールドで、受信要求で送信されるヘッダーを定義します。
      受信要求にそれらを含めるように要求するには、[必須] を選択します。
    10. エンドポイントが呼び出されたときに実行するアクションをフローに追加します。

      フローアクションでは、REST API トリガーのデータピルを使用できます。

      このアクションでは、インシデントレコードを作成し、[説明]フィールドと [アサイン先グループ] フィールドを受信ペイロードからインシデントにマップします。

    11. フローをテストしてアクティブ化します。
      詳細については、「フローをテストする」および「フローを有効化する」を参照してください。

      アクティブ化されると、エンドポイントが REST API エクスプローラーに表示されます。このページを使用して、エンドポイントをさらにテストしたり、サードパーティシステムからの要求を設定したりできます。

    12. サードパーティシステムから REST 要求を設定します。
      たとえば、この cURL 要求を送信して、前のステップで定義したフローをトリガーできます。
      curl "https:your-instance.servicenow.com/api/snc/create_incident_from_external_event/assignment_group/287ebd7da9fe198100f92cc8d1d2154e" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
fields: {
   description: \"Major outage with data loss\"
   }
}" \
--user 'username':'password'

    タスクの結果

    フローが実行され、REST 要求が実行 ID を返します。
    {
  "result": {
    "executionId": "ndoxeRhshDSezldeGfbYlviFSeFnBjCO"
  }
}

    次のタスク

    結果の実行 ID をコピーし、フローデザイナーの [実行] タブに移動します。実行 ID でフィルター処理して、実行の詳細を特定し、実行のステータスを表示できます。

    問題のトラブルシューティングを行うには、REST クエリをデバッグするか、フロー実行の詳細を確認します。「REST クエリのデバッグ」および「フロー実行の詳細」を参照してください。