Chapter 26. Working with Webhooks

Procedure

1. Generate a Personal Access Token (PAT) for use with automation controller:

   1. In the profile settings of your GitHub account, select Settings.
   2. From the navigation panel, select <> Developer Settings.
   3. On the Developer Settings page, select Personal access tokens.
   4. From the Personal access tokens screen, click Generate a personal access token.
   5. When prompted, enter your GitHub account password to continue.
   6. In the Note field, enter a brief description about what this PAT is used for.
   7. In the Select scopes fields, check the boxes next to repo:status, repo_deployment, and public_repo. The automation webhook only needs repository scope access, with the exception of invites. For more information, see Scopes for OAuth apps documentation.

   8. Click Generate token.

      Important

      When the token is generated, ensure that you copy the PAT, as you need it in step 2. You cannot access this token again in GitHub.

2. Use the PAT to optionally create a GitHub credential:

   1. Go to your instance, and Create a new credential for the GitHub PAT using the generated token.

   2. Make note of the name of this credential, as you use it in the job template that posts back to GitHub.

      

   3. Go to the job template with which you want to enable webhooks, and select the webhook service and credential you created in the preceding step.

      
   4. Click Save. Your job template is set up to post back to GitHub.
3. Go to a GitHub repository where you want to configure webhooks and select Settings.
4. From the navigation panel, select Webhooks Add webhook.
5. To complete the Add webhook page, you must check the Enable Webhook option in a job template or workflow job template. For more information, see step 3 in both Creating a job template and Creating a workflow template.

6. Complete the following fields:

   • Payload URL: Copy the contents of the Webhook URL from the job template and paste it here. The results are sent to this address from GitHub.
   • Content type: Set it to application/json.
   • Secret: Copy the contents of the Webhook Key from the job template and paste it here.

   • Which events would you like to trigger this webhook?: Select the types of events you want to trigger a webhook. Any such event will trigger the job or workflow. To have the job status (pending, error, success) sent back to GitHub, you must select Pull requests in the Let me select individual events section.

     
   • Active: Leave this checked.
7. Click Add webhook.
8. When your webhook is configured, it is displayed in the list of webhooks active for your repository, along with the ability to edit or delete it. Click on a webhook, to go to the Manage webhook screen.
9. Scroll to view the delivery attempts made to your webhook and whether they succeeded or failed.

Procedure

1. Generate a Personal Access Token (PAT) for use with automation controller:

   1. From the navigation panel in GitLab, select your avatar and Edit profile.
   2. From the navigation panel, select Access tokens.

   3. Complete the following fields:

      • Token name: Enter a brief description about what this PAT is used for.
      • Expiration date: Skip this field unless you want to set an expiration date for your webhook.
      • Select scopes: Select those that are applicable to your integration. For automation controller, api is the only selection necessary.

   4. Click Create personal access token.

      Important

      When the token is generated, ensure that you copy the PAT, as you need it in step 2. You cannot access this token again in GitLab.

2. Use the PAT to optionally create a GitLab credential:

   1. Go to your instance, and create a new credential for the GitLab PAT using the generated token.

   2. Make note of the name of this credential, as you use it in the job template that posts back to GitLab.

      

   3. Go to the job template with which you want to enable webhooks, and select the webhook service and credential you created in the preceding step.

      
   4. Click Save. Your job template is set up to post back to GitLab.
3. Go to a GitLab repository where you want to configure webhooks.
4. From the navigation panel, select Settings Integrations.
5. To complete the Add webhook page, you must check the Enable Webhook option in a job template or workflow job template. For more information, see step 3 in both Creating a job template and Creating a workflow template.

6. Complete the following fields:

   • URL: Copy the contents of the Webhook URL from the job template and paste it here. The results are sent to this address from GitLab.
   • Secret Token: Copy the contents of the Webhook Key from the job template and paste it here.
   • Trigger: Select the types of events you want to trigger a webhook. Any such event will trigger the job or workflow. To have job status (pending, error, success) sent back to GitLab, you must select Merge request events in the Trigger section.
   • SSL verification: Leave Enable SSL verification selected.
7. Click Add webhook.
8. When your webhook is configured, it is displayed in the list Project Webhooks for your repository, along with the ability to test events, edit or delete the webhook. Testing a webhook event displays the results on each page whether it succeeded or failed.

Procedure

1. From the navigation panel, select Views Jobs.
2. Select the job template with the webhook enabled.
3. Select the Details tab.
4. In the Extra Variables field, view the payload output from the awx_webhook_payload variable, as shown in the following example: