Module Values.WebhookSource

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

Sourcetype nonrec t = {
  1. url : NonEmptyString.t option;
    (*

    The URL to the webhook.

    *)
  2. payloadUrl : NonEmptyString.t option;
    (*

    The CodeBuild endpoint where webhook events are sent.

    *)
  3. secret : NonEmptyString.t option;
    (*

    The secret token of the associated repository. A Bitbucket webhook does not support secret.

    *)
  4. branchFilter : String_.t option;
    (*

    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.

    *)
  5. filterGroups : FilterGroups.t option;
    (*

    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.

    *)
  6. buildType : WebhookBuildType.t option;
    (*

    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.

    *)
  7. manualCreation : WrapperBoolean.t option;
    (*

    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.

    *)
  8. lastModifiedSecret : Timestamp.t option;
    (*

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

    *)
  9. scopeConfiguration : ScopeConfiguration.t option;
    (*

    The scope configuration for global or organization webhooks. Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

    *)
  10. status : WebhookStatus.t option;
    (*

    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.

    *)
  11. statusMessage : String_.t option;
    (*

    A message associated with the status of a webhook.

    *)
  12. pullRequestBuildPolicy : PullRequestBuildPolicy.t option;
}
Sourceval make : ?url:??? -> ?payloadUrl:??? -> ?secret:??? -> ?branchFilter:??? -> ?filterGroups:??? -> ?buildType:??? -> ?manualCreation:??? -> ?lastModifiedSecret:??? -> ?scopeConfiguration:??? -> ?status:??? -> ?statusMessage:??? -> ?pullRequestBuildPolicy:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of WrapperBoolean.t | `Enum of string | `List of [> `List of [> `Structure of (string * [> `Boolean of WrapperBoolean.t | `Enum of string | `String of String_.t ]) list ] list ] list | `String of NonEmptyString.t | `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `String of String_.t ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t