インバウンド Webhook の参照

ワークフロー リクエスト

Webhook リクエスト URL を使用すると、[POST (投稿)] リクエストを作成して、Bridge ワークフローを開始することができます。以下のリクエスト本文を使用できます。

{

    "workflow":"workflow name or UUID",

    "stateValues":{ 

        "statename":"value"

    },

    "uid":"a generated unique ID for the request",

    "extra_stuff":{

        "lots":"of it"

    }

}

• [workflow (ワークフロー)]: 唯一の必須フィールドです。有効なワークフロー名または UUID 値として設定する必要があります。
• [stateValues (状態の値)]: ワークフローの状態を指定された値で事前設定するために使用するオプションのフィールドです。
• [uid (ユニーク ID)]: 同じリクエストを複数回送信した場合に、重複したリクエストが無視されるようにする一意の識別子 (uid) です。
• [POST (投稿)] 本文の一部として送信するその他のすべてのフィールド: 
  • ワークフローに渡され、「{{runtime.extra_stuff.lots}}」などのランタイムのハンドルバーを使用して、返ってきた値と共に参照されます。 
  • 有効な JSON 値がすべて渡されます。

このエンドポイントへのすべてのリクエストには、シークレット値を設定するため、Inbound-Webhook-Secret のヘッダーが必要です。

このソリューションでは、チャレンジ リクエストを含む Webhook はサポートしていません。この場合は新しいカスタム統合の構築が必要です。

ワークフロー バッチ リクエスト

単一のリクエストで複数のワークフローを実行する場合は、リクエスト本文の一部としてバッチ オブジェクトを渡すことができます。

{

    "workflow":"workflow name or UUID",

    "batch":[

        {

            "uid": "request1",

            "workflow":"alternative workflow",

            "stateValues":{

                "state":"value"

            },

            "runtimeData":{

                "key":"value"

            }

        },

        {

            "uid": "request2",

            "stateValues":{

                "state":"value"

            }

        }

    ]

}

注

• バッチ リクエスト オブジェクトは、メインのリクエストと同じフィールドを使用しますが、[runtimeData (ランタイム データ)] が追加されています。これはワークフローの {{runtime}} ハンドルバーが利用可能なデータを設定するために使用します。

• バッチ リクエスト オブジェクトでワークフローまたは状態の値を指定しない場合、親オブジェクトに設定されている値が代わりに使用されます。上記の例では、2 つのワークフローが [request1 (リクエスト 1)] (代替ワークフロー) と [request2 (リクエスト 2)] (初期ワークフロー) を実行します。
• 親の値を空の値で上書きする場合は、[stateValues (状態の値)] に空のオブジェクトを設定します。未定義の値は設定されていないものとして扱われ、親の値が使用されます。バッチ リクエスト使用中は、親オブジェクトの [uid] フィールドは無視されますが、各バッチ オブジェクトには必要に応じて独自の [uid] を設定できます。
• 各バッチ オブジェクトが独自のワークフローを定義している場合でも、メイン リクエストに含まれるワークフローは依然として必要です。