GitHub webhook events - AWS CodeBuild

GitHub webhook events

You can use webhook filter groups to specify which GitHub webhook events trigger a build. For example, you can specify that a build is only triggered for changes to specific branches.

You can create one or more webhook filter groups to specify which webhook events trigger a build. A build is triggered if any filter group evaluates to true, which occurs when all the filters in the group evaluate to true. When you create a filter group, you specify:

An event

For GitHub, you can choose one or more of the following events: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, PULL_REQUEST_CLOSED, RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED. The webhook event type is in the X-GitHub-Event header in the webhook payload. In the X-GitHub-Event header, you might see pull_request or push. For a pull request event, the type is in the action field of the webhook event payload. The following table shows how X-GitHub-Event header values and webhook pull request payload action field values map to the available event types.

X-GitHub-Event Header value Webhook event payload action value Event type
pull_request opened PULL_REQUEST_CREATED
pull_request reopened PULL_REQUEST_REOPENED
pull_request synchronize PULL_REQUEST_UPDATED
pull_request closed, and the merged field is true PULL_REQUEST_MERGED
pull_request closed, and the merged field is false PULL_REQUEST_CLOSED
push n/a PUSH
release released RELEASED
release prereleased PRERELEASED
workflow_job queued WORKFLOW_JOB_QUEUED
Note

The PULL_REQUEST_REOPENED event type can be used with GitHub and GitHub Enterprise Server only. The RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED event type can be used with GitHub only. For more information on WORKFLOW_JOB_QUEUED, see Tutorial: Configure a CodeBuild-hosted GitHub Actions runner.

One or more optional filters

Use a regular expression to specify a filter. For an event to trigger a build, every filter within the group associated with it must evaluate to true.

ACTOR_ACCOUNT_ID (ACTOR_ID in the console)

A webhook event triggers a build when a GitHub or GitHub Enterprise Server account ID matches the regular expression pattern. This value is found in the id property of the sender object in the webhook payload.

HEAD_REF

A webhook event triggers a build when the head reference matches the regular expression pattern (for example, refs/heads/branch-name or refs/tags/tag-name). For a push event, the reference name is found in the ref property in the webhook payload. For pull requests events, the branch name is found in the ref property of the head object in the webhook payload.

BASE_REF

A webhook event triggers a build when the base reference matches the regular expression pattern (for example, refs/heads/branch-name). A BASE_REF filter can be used with pull request events only. The branch name is found in the ref property of the base object in the webhook payload.

FILE_PATH

A webhook triggers a build when the path of a changed file matches the regular expressions pattern. A FILE_PATH filter can be used with GitHub push and pull request events and GitHub Enterprise Server push events. It cannot be used with GitHub Enterprise Server pull request events.

COMMIT_MESSAGE

A webhook triggers a build when the head commit message matches the regular expression pattern. A COMMIT_MESSAGE filter can be used with GitHub push and pull request events and GitHub Enterprise Server push events. It cannot be used with GitHub Enterprise Server pull request events.

TAG_NAME

A webhook triggers a build when the tag name of the release matches the regular expression pattern. A TAG_NAME filter can be used with GitHub released and prereleased request events.

RELEASE_NAME

A webhook triggers a build when the release name matches the regular expression pattern. A RELEASE_NAME filter can be used with GitHub released and prereleased request events.

REPOSITORY_NAME

A webhook triggers a build when the repository name matches the regular expression pattern. A REPOSITORY_NAME filter can only be used with GitHub global or organization webhooks.

WORKFLOW_NAME

A webhook triggers a build when the workflow name matches the regular expression pattern. A WORKFLOW_NAME filter can be used with GitHub Actions workflow job queued request events.

Note

You can find the webhook payload in the webhook settings of your GitHub repository.

Topics