Skip to main content Skip to complementary content
Announcements

Defining a Webhook parameter in Talend Studio

You can define a webhook context parameter in a Job to allow the web user to generate unique URLs of tasks from Talend Management Console. These URLs allow external applications (Salesforce, Box, Dropbox and so on) to trigger the execution of a task on any data change.

Before you begin

The Job is open in Talend Studio and the Context view below the design workspace is selected.

About this task

For example, the following Job retrieves contacts from Salesforce. You need to trigger the execution of the task every time the Salesforce contacts are updated.
Job in the design workspace.

Procedure

  1. In the Talend Studio workspace, click the Context view.

    If the Context view does not show in Talend Studio, click Window > Show view > Talend , and select Context.

  2. Click the [+] button in the Context view to add a line in the table.

    Example

    Context view.
  3. Define the webhook context parameter following the pattern resource_webhook_payload, all in lower case.
  4. Set the type of the parameter to String.
  5. Enter the value for the webhook parameter.
    Webhooks must be defined in a JSON format, where:
    • type: media type of the payload taken from Content-Type header, for example, application/json.
    • data: payload data
    The following payload types are supported:
    • application/xml
    • application/json
    • text/plain
    • text/xml

    Example

    [ { "type": "text/plain", "data": "Some Data" }, { "type": "application/xml", "data": "<SomeXml/>" } ]
  6. Right-click the Job in the Repository tree view and select Publish to Cloud.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here