webMethods API Gateway

Know how to run private webhook-based workflows by using webMethods API Gateway.

About this task

Run a private webhook-based workflow by using webMethods API Gateway.

Procedure

  1. Enable the Private Webhook option for your workflow. The Webhook URL shows two distinct URLs: Internal url and Private url.
  2. Copy the Internal url provided on the webhook configuration page after the private webhook is enabled. Use this URL for the rest of the configurations.
  3. Create an Alias in webMethods API Gateway. Log in to webMethods API Gateway, click the profile icon, and select Aliases.
  4. Click Create Alias, provide an alias name, and then select the Technical information option. In the Default value field, paste the internal url, and then remove everything after the /run part. Next, save the alias.
  5. Create and configure the API. Click the APIs menu, select Create API, and then select the Create API from scratch option. Under API details, provide an API name, and then click the Technical information option.
  6. In the Server URL field, paste the wehbook URL, and then remove everything after the /run part. Click Add.
  7. Click Resources and methods.
  8. Click Add resources. In the Resource name field, provide a name.
  9. In the Resource path field, enter everything after the /run part from the webhook URL.
  10. Select the required HTTP methods and then click Add.
  11. Enable the HTTPS protocol. Go to the Policies menu, click Edit, and enable the HTTP and HTTPS protocols.
  12. Define routing configurations. Go to Routing. In the Endpoint URI, field, provide the alias and resource path as inputs. To enter an alias as input, enter ${alias name}.
    For example, ${PrivateInternal}
    To enter the resource path as input, enter ${sys:resource_path}.
  13. Set the required HTTP Connection Timeout (maximum 5 minutes) and Read Timeout (maximum 5 minutes) and click Save.
  14. Activate the API. Click Activate and then confirm the activation action.
  15. Copy the Gateway endpoint URL. Go to the API details menu, scroll down to the Gateway endpoint(s) section, and copy the endpoint. Now, you can use this URL to run the associated private webhook-based workflow by sending HTTP requests to it. If the webhook authentication method is set at the time of configuring the webhook, then ensure that you provide the necessary authentication details in the HTTP request.