Triggering plan execution through a webhook - Cloud

Talend Management Console for Pipelines User Guide
Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend Pipeline Designer
Content
Administration and Monitoring > Managing projects
Administration and Monitoring > Managing users
Deployment > Deploying > Executing Tasks
Deployment > Scheduling > Scheduling Tasks
Last publication date
2024-04-04

Webhooks can trigger the execution of a plan based on calls from external applications.

You cannot add a webhook if you already had other trigger types. You can delete other triggers and add a webhook when editing the task/plan, or you can also copy the task/plan if you need both.

About this task

You must generate a unique URL for your plan in Talend Management Console, then supply it in the POST HTTP call from the external application that will trigger the execution.

Procedure

  1. If you are editing your plan after it has been created, go to its details page, then click the icon next to Trigger.
  2. Click the Add trigger icon.
  3. Enter the name of the trigger.
    The name must contain only alphanumeric, "-", "#" and "_" characters. Spaces and other special characters are not allowed.
  4. Select Webhook from the Trigger type drop-down list.
  5. Enter the name of the webhook in the Webhook name field.
    The name must contain only alphanumeric characters and underscores (_). Spaces and other special characters are not allowed.
  6. Define the information relative to the webhook execution.
    • Window threshold: defines the number of calls to the service.
    • Window duration (in seconds): defines the number of seconds after the first service call.
  7. Optional: Enter a description.
  8. Click Save and close.

Results

The Webhook URL is generated. To get the Webhook URL:
  • Click the Copy icon next to the URL field.
  • Click the information icon next to the webhook name under Trigger > Trigger type > Webhook in the task/plan details page.