Create a Triggered Task

  • You must have permissions to Project space and Project to create and update Triggered Tasks.

  • You must have a Cloudplex or Groundplex set up to run Triggered Tasks successfully.

A Triggered Task exposes a SnapLogic pipeline as an authenticated HTTP endpoint, allowing external applications, webhooks, or scheduled scripts to invoke the pipeline on demand via a REST API call.

Choose either of the following ways to open the Create Task dialog:

Designer Open the target pipeline, and click the Task icon in the Designer toolbar. When you create a Triggered Task in Designer, the pipeline is pre-selected when you open the Create Task dialog.
Project Manager Navigate to the target Project folder, click the Create icon and select Triggered Task.

Create Task in Manager

When you create a Triggered Task in Project Manager, you must select a pipeline to associate with the Task.
  1. Specify the details in the Create Task dialog:
    • Name: Specify a name for the Triggered Task. This name is used in the URL when the pipeline has unconnected inputs or outputs.
      Important: The names of assets, projects, or project spaces are limited to UTF-8 alphanumeric characters and these special characters: !"$%&'()*+-.:;<=>@[]^_`{|}~.
    • Pipeline: Select the pipeline to run. This pipeline is triggered when the Triggered Task is called. If applicable, edit any of the parameter values from the pipeline.
      • In Designer, the pipeline is preselected, hence this field is greyed out.
      • In Project Manager, you can select and execute pipelines across any Project or Project space (to which you have access) using a hierarchical tree selector (Project Space > Project > Pipeline).
    • Snaplex: Select the Snaplex on which to run the pipeline.
    • Timeout (minutes): Specify the timeout after which the pipeline stops execution. Learn more.
  2. Configure the Notifications for the Triggered Task. Learn more.
  3. Configure the following Debug settings as required.
    • Record the next five triggers of this task: Select this checkbox to record five triggers of this Task after its creation.
    • Do not start a new execution if one is already active: Select this checkbox if you prefer to wait until the task is complete before it can be re-triggered. This option lets you prevent a pipeline from running again if a previous execution of that pipeline is already running. If you attempt to call the Triggered Task when it is already running, you will encounter a 409 error.
    Note: On a multi-node Snaplex, this option is a best-effort protection rather than a strict guarantee. Refer to Best practices for why, and how to reduce the impact of an occasional overlapping execution.
  4. You can use the auto-generated Bearer token as the HTTP Authorization header. If you clear this field, then requests are authenticated by the pipeline itself. You can also modify the field value as required.
  5. Click Save. The task is listed in the Assets page under Tasks tab.
  6. Optionally, to create an API in API Manager, click Save and create API. Learn more about creating APIs from Triggered Tasks.

You can run your Triggered Task through a variety of methods. Refer to Running Triggered Tasks for details.