http (HTTP)

An HTTP triggerer executes an orchestration when an HTTP endpoint, defined by the Flow server's base URL plus path, is visited.

The path is a mandatory field.

class names

scala: code.data.HttpTriggererFactory
javascript: code_data_HttpTriggererFactory

aliases

config

{"categories":[{"defaultCollapsed":true,"fields":["streamType","mutualReentranceKey","nonReentrant","killOnStop","orchestrationTimeout","orchestratorName","env","isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics"],"name":"Advanced Run Configuration"}],"fieldName":"http","fields":[{"default":[],"fieldName":"http.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"http.runOnlyOnRanks","hidden":false,"hideLabel":false,"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"I","validators":[]},"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"http.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"http","fieldName":"http.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"http.bundle","hidden":false,"hideLabel":false,"name":"bundle","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"http.mutualReentrancyKey","hidden":false,"hideLabel":false,"name":"mutualReentrancyKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"http.path","hidden":false,"hideLabel":false,"name":"path","readonly":false,"renderStrategies":[],"type":"S","validators":[{"pattern":"^[\\/]?[^\\/\\n\\r]+[^\\n\\r]*$","rule":"regexMatch"}]},{"default":"collecting","fieldName":"http.streamType","hidden":false,"hideLabel":false,"name":"streamType","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["collecting","eager","forgetful"],"displayOverride":{},"rule":"choices","unenforced":false}]},{"default":false,"fieldName":"http.deepDiagnostics","hidden":false,"hideLabel":false,"name":"deepDiagnostics","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":180000,"fieldName":"http.authTimeout","hidden":false,"hideLabel":false,"name":"authTimeout","readonly":false,"renderStrategies":[],"type":"L","validators":[]},{"default":[],"fieldName":"http.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"http.runOnlyOnRoles","hidden":false,"hideLabel":false,"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["frontend","backend","viewer"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"A"},{"default":"","fieldName":"http.description","hidden":false,"hideLabel":false,"name":"description","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":false,"fieldName":"http.stateful","hidden":false,"hideLabel":false,"name":"stateful","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":10,"fieldName":"http.poolSize","hidden":false,"hideLabel":false,"name":"poolSize","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":false,"fieldName":"http.nonReentrant","hidden":false,"hideLabel":false,"name":"nonReentrant","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"http.orchestratorName","hidden":false,"hideLabel":false,"name":"orchestratorName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"http.outputTransformerFunc","hidden":false,"hideLabel":false,"name":"outputTransformerFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":false,"fieldName":"http.removeDefaultCachingHeaders","hidden":false,"hideLabel":false,"name":"removeDefaultCachingHeaders","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"http.immutable","hidden":false,"hideLabel":false,"name":"immutable","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":"T1726099536658_F99803547262OBOG0X","fieldName":"http.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"http.simpleTransformerFunc","hidden":false,"hideLabel":false,"name":"simpleTransformerFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":false,"fieldName":"http.simple","hidden":false,"hideLabel":false,"name":"simple","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"http.authenticationFlow","hidden":false,"hideLabel":false,"name":"authenticationFlow","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":[],"fieldName":"http.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"http.runOnlyOnHosts","hidden":false,"hideLabel":false,"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"http.isRunning","hidden":false,"hideLabel":false,"name":"isRunning","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"http.killOnStop","hidden":false,"hideLabel":false,"name":"killOnStop","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"canReference":false,"default":180000,"fieldName":"http.orchestrationTimeout","hidden":false,"hideLabel":false,"label":"Orchestration Timeout","name":"orchestrationTimeout","readonly":false,"renderStrategies":[{"config":{"precision":3,"timeUnit":"ms"},"type":"valueAsTimeSpan"}],"type":"L","validators":[]},{"default":"statefulBehaviour","fieldName":"http.type","hidden":false,"hideLabel":false,"name":"type","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"http.env","hidden":false,"hideLabel":false,"name":"env","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Triggerer Configuration","name":"http","readonly":false,"renderStrategies":[],"type":"O"}