Webhook
Information about a webhook that connects repository events to a build project in AWS CodeBuild.
Contents
Note
In the following list, the required parameters are described first.
- branchFilter
-
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If
branchFilteris empty, then all branches are built.Note
It is recommended that you use
filterGroupsinstead ofbranchFilter.Type: String
Required: No
- buildType
-
Specifies the type of build this webhook will trigger.
Type: String
Valid Values:
BUILD | BUILD_BATCHRequired: No
- filterGroups
-
An array of arrays of
WebhookFilterobjects used to determine which webhooks are triggered. At least oneWebhookFilterin the array must specifyEVENTas itstype.For a build to be triggered, at least one filter group in the
filterGroupsarray must pass. For a filter group to pass, each of its filters must pass.Type: Array of arrays of WebhookFilter objects
Required: No
- lastModifiedSecret
-
A timestamp that indicates the last time a repository's secret token was modified.
Type: Timestamp
Required: No
- payloadUrl
-
The AWS CodeBuild endpoint where webhook events are sent.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- secret
-
The secret token of the associated repository.
Note
A Bitbucket webhook does not support
secret.Type: String
Length Constraints: Minimum length of 1.
Required: No
- url
-
The URL to the webhook.
Type: String
Length Constraints: Minimum length of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
