Skip to content

/AWS1/CL_BLDWEBHOOK

Information about a webhook that connects repository events to a build project in CodeBuild.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_url TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The URL to the webhook.

iv_payloadurl TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The CodeBuild endpoint where webhook events are sent.

iv_secret TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

iv_branchfilter TYPE /AWS1/BLDSTRING /AWS1/BLDSTRING

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 branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

it_filtergroups TYPE /AWS1/CL_BLDWEBHOOKFILTER=>TT_FILTERGROUPS TT_FILTERGROUPS

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

iv_buildtype TYPE /AWS1/BLDWEBHOOKBUILDTYPE /AWS1/BLDWEBHOOKBUILDTYPE

Specifies the type of build this webhook will trigger.

RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.

iv_manualcreation TYPE /AWS1/BLDWRAPPERBOOLEAN /AWS1/BLDWRAPPERBOOLEAN

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

manualCreation is only available for GitHub webhooks.

iv_lastmodifiedsecret TYPE /AWS1/BLDTIMESTAMP /AWS1/BLDTIMESTAMP

A timestamp that indicates the last time a repository's secret token was modified.

io_scopeconfiguration TYPE REF TO /AWS1/CL_BLDSCOPECONFIGURATION /AWS1/CL_BLDSCOPECONFIGURATION

The scope configuration for global or organization webhooks.

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

iv_status TYPE /AWS1/BLDWEBHOOKSTATUS /AWS1/BLDWEBHOOKSTATUS

The status of the webhook. Valid values include:

  • CREATING: The webhook is being created.

  • CREATE_FAILED: The webhook has failed to create.

  • ACTIVE: The webhook has succeeded and is active.

  • DELETING: The webhook is being deleted.

iv_statusmessage TYPE /AWS1/BLDSTRING /AWS1/BLDSTRING

A message associated with the status of a webhook.

io_pullrequestbuildpolicy TYPE REF TO /AWS1/CL_BLDPULLREQBUILDPOLICY /AWS1/CL_BLDPULLREQBUILDPOLICY

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

Queryable Attributes

url

The URL to the webhook.

Accessible with the following methods

Method Description
GET_URL() Getter for URL, with configurable default
ASK_URL() Getter for URL w/ exceptions if field has no value
HAS_URL() Determine if URL has a value

payloadUrl

The CodeBuild endpoint where webhook events are sent.

Accessible with the following methods

Method Description
GET_PAYLOADURL() Getter for PAYLOADURL, with configurable default
ASK_PAYLOADURL() Getter for PAYLOADURL w/ exceptions if field has no value
HAS_PAYLOADURL() Determine if PAYLOADURL has a value

secret

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

Accessible with the following methods

Method Description
GET_SECRET() Getter for SECRET, with configurable default
ASK_SECRET() Getter for SECRET w/ exceptions if field has no value
HAS_SECRET() Determine if SECRET has a value

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 branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

Accessible with the following methods

Method Description
GET_BRANCHFILTER() Getter for BRANCHFILTER, with configurable default
ASK_BRANCHFILTER() Getter for BRANCHFILTER w/ exceptions if field has no value
HAS_BRANCHFILTER() Determine if BRANCHFILTER has a value

filterGroups

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

Accessible with the following methods

Method Description
GET_FILTERGROUPS() Getter for FILTERGROUPS, with configurable default
ASK_FILTERGROUPS() Getter for FILTERGROUPS w/ exceptions if field has no value
HAS_FILTERGROUPS() Determine if FILTERGROUPS has a value

buildType

Specifies the type of build this webhook will trigger.

RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.

Accessible with the following methods

Method Description
GET_BUILDTYPE() Getter for BUILDTYPE, with configurable default
ASK_BUILDTYPE() Getter for BUILDTYPE w/ exceptions if field has no value
HAS_BUILDTYPE() Determine if BUILDTYPE has a value

manualCreation

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

manualCreation is only available for GitHub webhooks.

Accessible with the following methods

Method Description
GET_MANUALCREATION() Getter for MANUALCREATION, with configurable default
ASK_MANUALCREATION() Getter for MANUALCREATION w/ exceptions if field has no valu
HAS_MANUALCREATION() Determine if MANUALCREATION has a value

lastModifiedSecret

A timestamp that indicates the last time a repository's secret token was modified.

Accessible with the following methods

Method Description
GET_LASTMODIFIEDSECRET() Getter for LASTMODIFIEDSECRET, with configurable default
ASK_LASTMODIFIEDSECRET() Getter for LASTMODIFIEDSECRET w/ exceptions if field has no
HAS_LASTMODIFIEDSECRET() Determine if LASTMODIFIEDSECRET has a value

scopeConfiguration

The scope configuration for global or organization webhooks.

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

Accessible with the following methods

Method Description
GET_SCOPECONFIGURATION() Getter for SCOPECONFIGURATION

status

The status of the webhook. Valid values include:

  • CREATING: The webhook is being created.

  • CREATE_FAILED: The webhook has failed to create.

  • ACTIVE: The webhook has succeeded and is active.

  • DELETING: The webhook is being deleted.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

statusMessage

A message associated with the status of a webhook.

Accessible with the following methods

Method Description
GET_STATUSMESSAGE() Getter for STATUSMESSAGE, with configurable default
ASK_STATUSMESSAGE() Getter for STATUSMESSAGE w/ exceptions if field has no value
HAS_STATUSMESSAGE() Determine if STATUSMESSAGE has a value

pullRequestBuildPolicy

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

Accessible with the following methods

Method Description
GET_PULLREQUESTBUILDPOLICY() Getter for PULLREQUESTBUILDPOLICY