Webhook ¶

class Webhook(TypedDict, closed=True):
    url: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The URL to the webhook.</p>"""
    payload_url: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The CodeBuild endpoint where webhook events are sent.</p>"""
    secret: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The secret token of the associated repository. </p> <note> <p>A Bitbucket webhook does not support <code>secret</code>. </p> </note>"""
    branch_filter: NotRequired["capo_codebuild.types.string.String"]
    """<p>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 <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p>It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>"""
    filter_groups: NotRequired["capo_codebuild.types.filter_groups.FilterGroups"]
    """<p>An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p>For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>"""
    build_type: NotRequired["capo_codebuild.types.webhook_build_type.WebhookBuildType"]
    """<p>Specifies the type of build this webhook will trigger.</p> <note> <p> <code>RUNNER_BUILDKITE_BUILD</code> is only available for <code>NO_SOURCE</code> source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-runner-buildkite.html">Tutorial: Configure a CodeBuild-hosted Buildkite runner</a> in the <i>CodeBuild user guide</i>.</p> </note>"""
    manual_creation: NotRequired["capo_codebuild.types.wrapper_boolean.WrapperBoolean"]
    """<p>If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns <code>payloadUrl</code> and <code>secret</code> values for the webhook. The <code>payloadUrl</code> and <code>secret</code> values in the output can be used to manually create a webhook within GitHub.</p> <note> <p>manualCreation is only available for GitHub webhooks.</p> </note>"""
    last_modified_secret: NotRequired["capo_codebuild.types.timestamp.Timestamp"]
    """<p>A timestamp that indicates the last time a repository's secret token was modified. </p>"""
    scope_configuration: NotRequired[
        "capo_codebuild.types.scope_configuration.ScopeConfiguration"
    ]
    """<p>The scope configuration for global or organization webhooks.</p> <note> <p>Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.</p> </note>"""
    status: NotRequired["capo_codebuild.types.webhook_status.WebhookStatus"]
    """<p>The status of the webhook. Valid values include:</p> <ul> <li> <p> <code>CREATING</code>: The webhook is being created.</p> </li> <li> <p> <code>CREATE_FAILED</code>: The webhook has failed to create.</p> </li> <li> <p> <code>ACTIVE</code>: The webhook has succeeded and is active.</p> </li> <li> <p> <code>DELETING</code>: The webhook is being deleted.</p> </li> </ul>"""
    status_message: NotRequired["capo_codebuild.types.string.String"]
    """<p>A message associated with the status of a webhook.</p>"""
    pull_request_build_policy: NotRequired[
        "capo_codebuild.types.pull_request_build_policy.PullRequestBuildPolicy"
    ]