Skip to main content

Setting up CI job webhooks for AWS CodeCommit

How to set up your CI job with webhooks, to deploy changes made to a branch

Valerio Chang avatar
Written by Valerio Chang
Updated this week

This document is a guide to setting up a webhook for CI jobs or Pipelines in Gearset, that deploys changes from an AWS CodeCommit repository when the source branch changes.

Prerequisites before setting up CodeCommit webhooks:

  • You have added a repository connection for AWS CodeCommit (see our guide on Integrating with AWS CodeCommit).

  • The AWS CodeCommit repository you are connecting to is not blank and that there is at least one branch (e.g. Main) to work with; otherwise, you will get an error when you select the Source repository field on the CI Add new deployment job page.

For all CI jobs you will need:

  • 1 SNS Topic and Subscription

  • 1 Eventbridge Rule

  • 1 Trigger


​

Creating a CI job in Gearset


These steps will let you know how to create a CI job in Gearset. If you've already created a CI job, select Webhook setup in the CI job menu:


Note down your Payload URL and Shared secret, and proceed with the next step in the article to add your webhook.
​

  1. To get started, from the Continuous integration page in Gearset, click Add new deployment job or Add new team-shared deployment job.

  2. Select AWS CodeCommit as the Source type.

  3. Under Deployment behavior, select when the source branch is updated.

Configure the other options, click Save, and you will see another dialog box with the webhook information in it. Next, save the Payload URL and Shared secret for use later on to create and configure your CodeCommit webhooks.

Adding a Webhook

  1. In the AWS Management Console, go to the Amazon SNS section and search Simple Notification Service.

  2. Create a new topic, then create a new subscription for that topic.

  3. Choose a name for your topic, and set its type as standard.

  4. Set Protocol to HTTPS.

  5. Set the Endpoint to the Payload URL you have saved from Gearset’s webhook setup dialog earlier.

  6. The new subscription’s ID will be Pending confirmation.

  7. Click Request confirmations and hit refresh in the table. The subscription should then be assigned a proper subscription ID.

  8. In the AWS Management Console, go to AWS CodeCommit.

  9. For the repository you’re deploying, go to Settings, and then to Triggers.

  10. Click Create new trigger.

  11. Under Events, select Push to existing branch.

  12. Do not select any branches under Brach names so the webhook works for all branches in your pipeline.

  13. Select the SNS topic you created earlier.

  14. Under Custom data, paste in the Shared secret from Gearset’s webhook setup dialog earlier.

You can click Test trigger to confirm it can connect successfully. The next time you push to this branch, it will trigger the CI job in Gearset.

Setting up an EventBridge rule

Your CI job webhook will need an EventBridge rule to function correctly. After you've created your CI job webhook, please refer to our guide on EventBridge configuration for AWS CodeCommit.

Related Articles
EventBridge configuration for AWS CodeCommit
Setting up your first CI job in Gearset
CI job and Pipeline webhooks
Is the webhook set up for the CI job?
Setting up Pipeline webhooks for AWS CodeCommit
Did this answer your question?