Managing webhooks

The BMC AMI Products for Web communicate with BMC AMI mainframe products, such as Abend-AID and Code Pipeline, by issuing requests and receiving responses to those requests.

In a DevOps environment, you can use webhooks to enable third-party applications, such as Slack or Jenkins, to be notified when BMC AMI Products for Web or another utilities have performed an action.

Examples
  • You can make a Deploy request through BMC AMI Products for Web to an instance of Code Pipeline running on a mainframe. That instance of Code Pipeline will return a response to that request indicating the success or failure of the Deploy action.
  • You can enable a notification to be sent to Jenkins to kick off a build whenever a Promotion occurs in Code Pipeline.

Related topics

Getting-started

Adding-a-webhook

To view webhooks, you must have the Common Enterprise Service Webhook Viewing rights assigned to your user role.

On the Webhooks page, you can view a list of configured webhooks, including the name and status of the webhook, the URL of the location to which the response will be forwarded, the type of HTTP method that will be used when forwarding the response, if CSRF is enabled for a webhook, the SSL certificate associated with the webhook, and so on.

You can also perform the following actions:

Purpose

Action

Add a webhook.

Click Add. For more information, see Adding-a-webhook. To add a webhook, you must have the Common Enterprise Service Webhook Management rights assigned to your user role.

Edit a webhook.

Click Edit Edit.pngin the relevant row. To edit a webhook, you must have the Common Enterprise Service Webhook Management rights assigned to your user role.

Delete a webhook.

Click Delete Delete.pngin the relevant row. The webhook is removed from the list and the request is removed from the associated mainframe product.

Delete multiple webhooks.

Select the check boxes in the relevant rows and click Delete. The webhook is removed from the list and the request is removed from the associated mainframe product.

Sort the order in a column.

Click SortArrow.png(Sort arrow) in the column header.

Sort the order in multiple columns.

Perform the following steps:

  1. Click SortArrow.png(Sort arrow) in the column header in a column.
  2. To select more columns, perform one of the following options:
    • Press the ctrl (or command) key and click the sort arrow in the required column headers.
    • Click 3-dots.pngin the required column headers.
  3. For each selected column, go to the 3-dots.pngmenu, select Ascending or Descending, and select the desired Sort order.
    When you select a sort order, the column header displays a number to indicate the priority of the column in the sort sequence. The direction of the sort arrow indicates if the column is sorted in the ascending or descending order.

Thus, the table displays values sorted column-wise, one after the other, such that the previous sort order is not distorted by the next sort order.

From the 3-dots.pngoptions, you can also perform the following actions:

  • Change or swap the Sort order as required.
  • Remove a column from the multi-sort sequence by selecting Remove from current sort.
  • Remove all sorting by selecting Clear all sorting.

Search within the table.

In the Search field, enter the search criteria.

Filter the details at the column level.

In the Filter field, specify filter criteria. For example, to filter the list to all POST methods, enter POST in the Filter field. To further filter the list to all POST methods being sent to a URL containing the domain test.com, enter POST test.com in the Filter field.


Important

  • To add, edit, or delete a enabled webhook, you must have a valid host connection to the mainframe product, or require permissions be granted by an administrator.
  • Code Pipeline or Abend-AID must be configured to push notifications to your CES installation. You can configure the CES installation that Code Pipeline or Abend-AID will use in the BMC Common Mainframe Services Controller (CMSC).
  • Code Pipeline or Abend-AID does not persist notifications across restarts. Therefore, CES must be running before Code Pipeline or Abend-AID start for Code Pipeline or Abend-AID to register any older webhooks previously created in CES.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*