Skip to content

Update Webhook

codebuild_update_webhook R Documentation

Updates the webhook associated with an CodeBuild build project

Description

Updates the webhook associated with an CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

Usage

codebuild_update_webhook(projectName, branchFilter, rotateSecret,
  filterGroups, buildType)

Arguments

projectName

[required] The name of the CodeBuild project.

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.

rotateSecret

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

filterGroups

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

buildType

Specifies the type of build this webhook will trigger.

Value

A list with the following syntax: 

list(
  webhook = list(
    url = "string",
    payloadUrl = "string",
    secret = "string",
    branchFilter = "string",
    filterGroups = list(
      list(
        list(
          type = "EVENT"|"BASE_REF"|"HEAD_REF"|"ACTOR_ACCOUNT_ID"|"FILE_PATH"|"COMMIT_MESSAGE"|"WORKFLOW_NAME"|"TAG_NAME"|"RELEASE_NAME",
          pattern = "string",
          excludeMatchedPattern = TRUE|FALSE
        )
      )
    ),
    buildType = "BUILD"|"BUILD_BATCH",
    manualCreation = TRUE|FALSE,
    lastModifiedSecret = as.POSIXct(
      "2015-01-01"
    ),
    scopeConfiguration = list(
      name = "string",
      domain = "string",
      scope = "GITHUB_ORGANIZATION"|"GITHUB_GLOBAL"
    )
  )
)

Request syntax

svc$update_webhook(
  projectName = "string",
  branchFilter = "string",
  rotateSecret = TRUE|FALSE,
  filterGroups = list(
    list(
      list(
        type = "EVENT"|"BASE_REF"|"HEAD_REF"|"ACTOR_ACCOUNT_ID"|"FILE_PATH"|"COMMIT_MESSAGE"|"WORKFLOW_NAME"|"TAG_NAME"|"RELEASE_NAME",
        pattern = "string",
        excludeMatchedPattern = TRUE|FALSE
      )
    )
  ),
  buildType = "BUILD"|"BUILD_BATCH"
)