Use Call URLs for WebHook integration with other applications

ALM Octane supports WebHooks for integrating with other applications. Configure the WebHooks by creating a rule with the Call URL action. This topic provides end-to-end instructions for setting up all that is necessary for your Call URL rules to work.

Overview

The Call URL WebHook mechanism supports advanced workflow use case scenarios and enables integration with other applications.

Call URL rules send an HTTP/S request, with a payload in JSON format, to an endpoint URL when an event occurs in ALM Octane, such as entity creation, deletion, or update.

At the endpoint URL, an application receives the requests and processes the information.

Configure proxies

On-premises: You may have to ask the site admin to configure your organization's proxy so that outgoing requests are not blocked.

Proxies are set by modifying an octane.yml file and restarting the ALM Octane server. For details, see the information about configuring other settings in the ALM Octane Installation Guide.

Back to top

Customize Call URLs

Admins can customize how ALM Octane accesses the endpoint URL with configuration parameters.

You can customize:

  • Whether ALM Octane sends outgoing requests over HTTP or HTTPS, with CALL_URL_ALLOW_HTTP.

    When using HTTP, use only the standard port 80 for outgoing requests.

  • At what point the HTTP/S request times out, with CALL_URL_REQUEST_TIMEOUT.

For details, see Configuration parameters.

Back to top

Set up credentials (optional)

You may have to ask an admin to define credentials to be used for authenticating the request.

Call URL supports basic authentication. When you set credentials in the Call URL rule, each Call URL request includes a basic authentication header.

For details, see Set up credentials.

Back to top

Install an integration bridge (optional)

If the endpoint URL is not accessible by ALM Octane server, install an integration bridge. See Set up the Integration Bridge.

Back to top

Understand the Call URL request payload format

When processing a rule with the Call URL action, ALM Octane performs an HTTP/S POST request to the endpoint URL. The POST includes a JSON request payload.

Different payloads are sent depending on which event triggered the Call URL action.

Event Request payload
Create entity By default, the Call URL action includes only basic fields, such as ID and type.
Delete entity By default, the Call URL action includes only basic fields, such as ID and type.
Update entity By default, in addition to the basic fields, such as ID and type, the Call URL action includes a set of "before/after" changes.

When creating the Call URL rule, you can select additional fields to include in the request payload by specifying Fields.

All ALM Octane system field types are supported and may be sent in the payload. For details, see Field types.

User-defined fields (UDFs) are currently not supported and cannot be sent in the payload.

Payload format example

Back to top

Set up a web service at the endpoint

Set up and run a service at the endpoint that receives the requests and processes the information.

When setting up the web service, make sure that:

  • The service sends an HTTP/S response quickly so that ALM Octane does not misinterpret the delay as a failure and keep retrying.

  • The service must return a valid HTTP/S response so that ALM Octane does not misinterpret the response as a failure of the WebHook itself.

Back to top

Run the Call URL rule

After configuring the items and settings described above, you can run a Call URL rule created in ALM Octane Settings. For details, see Set up rules.

Back to top

See also: