Webhook task

Automatic tasks often need to interact with an external system through a REST interface. Although you could use a Jython Script task to send an HTTP query and parse the response, the Webhook task type is a simpler option.

To configure a Webhook, specify the URL to call and the details of the request including HTTP method, request body, and authentication. The task will perform the query, parse the response, and optionally extract results and include them in release variables.

Webhooks are available in XML and JSON, depending on the format of the HTTP response. Each format has its own way of extracting a result from the response:

  • XML webhook: Provide an XPath expression to select the value.
  • JSON webhooks: Use a JSON path.

This example is based on HttpBin, a free service to test REST clients. It uses the /ip endpoint, which returns the IP of the caller in a JSON response with the following structure:

  "origin": "xxx.xxx.xxx.xxx"

This is the configuration of the task in Release:

Webhook details

After the task is complete, the origin field is extracted from the response and stored in the ${xlreleaseIP} release variable, where it can be used by other tasks.

In the release flow editor, Webhook tasks have a blue border.