HTTP
Adding an HTTP trigger to a task enables the execution of this task using a web hook URL. The URL can be copied from the trigger configuration in the Task Planner GUI.
There is only one setting for this trigger: the task owner can decide whether the user triggering the task execution has to be authenticated. The following selection is available:
-
Only the owner and administrators - only the owner or an administrative user can trigger the task
-
All users with Taskplanner permission - users must have the Taskplanner permission
-
Every authenticated users - user have to be authenticated, no matter which permissions they have
-
Everyone - no authentication is required
The same task will not be queued for execution again if it is already in the queue or being executed.
If executing a task was successfully triggered (e.g. via browser or curl) an HTTP Status 200
with the task id will be the response. Errors will be presented depending on the content type.
Note: You have to have the WebAPI enabled to trigger tasks using the HTTP trigger.
Placeholders
The HTTP trigger supports placeholders that can be used in subsequent jobs and actions. You can use the following placeholders:
-
http.parameters
- a concatenated string of all parameters send to the trigger -
http.parameter1
-http.parameter9
- the first nineparameter
query entries send to the trigger
These parameters are filled by a query parameter called parameter
- which can be used multiple times. For details, please refer to the Web API.
Note: Please consider the security implications of using the placeholders. Please use responsibly.