Configuring a notification webhook in Ansible

After you configure an Ansible Automation Platform connector, you must set up a project-level notification webhook that is triggered on the success or failure of the Ansible job template.

Before you begin

Contact BMC Helix Support to enable Ansible integration and create notification webhooks successfully.

To create a notification webhook in Ansible

To create a notification webhook, perform the following minimum tasks:

1. In the navigation pane on the left-hand side of the Ansible UI, click Notifications.
2. Click Add.
3. On the Create New Notification Template page, enter the following details:
   1. Name: Enter a unique name for the notification.
   2. (Optional) Description: Describe the purpose of the notification.
   3. Organization: Enter the name of the organization created in Ansible.
   4. Type: Select Webhook.
4. In the Type details section, provide the following information:
   1. Username: Enter the tenant ID created in BMC Helix Portal.
   2. Basic Auth password: Enter the API access key for your BMC Helix tenant, generated in BMC Helix Portal.
      For more information, see Setting up access keys for programmatic access.
   3. Target URL: Choose one of the following options to enter the full URL to which the webhook notification will be POSTed.
      • If you configure the Ansible Automation Platform cloud connector, enter the URL in the following format:
        https://<hostname>/intelligent-automation/restplugin/api/v1/tmf/callback?ansible=true
      • If you configure the Ansible Automation Platform on-premises connector, enter the remote plugin URL in the following format:

        http://<remote-plugin-host>:<remote_plugin_port>/intelligent-automation/remote-restplugin/api/v1/tmf/callback?ansible=true

   4. HTTP headers: Enter the connector name in the following JSON format:
      {
        "connector_name": "<Name assigned to the Ansible Automation Platform connector>"
      }

   5. HTTP method: Select POST.
      This method creates a new notification webhook. It can also be used for operations that do not fit into other categories.
5. Click Save.

For more information, seeNotifications in the Ansible Tower documentation.

To enable a notification webhook in Ansible

After you create a notification webhook, you must enable it to receive alerts on the success and failure of the Ansible job templates. If all job templates are contained within a single project, we recommend that you enable project-level notifications to limit scope and reduce unnecessary load, since all the job templates in that project will use a single, common notification webhook for alerts.

To enable notifications for Projects, perform the following minimum steps:

1. In the navigation pane on the left-hand side of the Ansible UI, click Projects.
2. Select the Project assigned to the job template in Ansible.
3. Navigate to the Notifications tab.
4. Enable notifications on success and failure by using the toggle buttons.
   

For more information, seeProjects in the Ansible Tower documentation.