Module Values.PutWebhookOutputSource

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL. When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities. If a secret token was provided, it will be redacted in the response.

Sourcetype nonrec t = {
  1. webhook : ListWebhookItem.t option;
    (*

    The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.

    *)
}
Sourcetype nonrec error = [
  1. | `ConcurrentModificationException of ConcurrentModificationException.t
  2. | `InvalidTagsException of InvalidTagsException.t
  3. | `InvalidWebhookAuthenticationParametersException of InvalidWebhookAuthenticationParametersException.t
  4. | `InvalidWebhookFilterPatternException of InvalidWebhookFilterPatternException.t
  5. | `LimitExceededException of LimitExceededException.t
  6. | `PipelineNotFoundException of PipelineNotFoundException.t
  7. | `TooManyTagsException of TooManyTagsException.t
  8. | `ValidationException of ValidationException.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval make : ?webhook:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ConcurrentModificationException of ConcurrentModificationException.t | `InvalidTagsException of InvalidTagsException.t | `InvalidWebhookAuthenticationParametersException of unit | `InvalidWebhookFilterPatternException of unit | `LimitExceededException of unit | `PipelineNotFoundException of unit | `TooManyTagsException of TooManyTagsException.t | `Unknown_operation_error of string * string option | `ValidationException of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ConcurrentModificationException of ConcurrentModificationException.t | `InvalidTagsException of InvalidTagsException.t | `InvalidWebhookAuthenticationParametersException of unit | `InvalidWebhookFilterPatternException of unit | `LimitExceededException of unit | `PipelineNotFoundException of unit | `TooManyTagsException of TooManyTagsException.t | `Unknown_operation_error of string * string option | `ValidationException of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of TagKey.t ]) list ] list | `String of WebhookUrl.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of JsonPath.t ]) list ] list | `String of WebhookName.t | `Structure of (string * [> `String of WebhookAuthConfigurationAllowedIPRange.t ]) list ]) list | `Timestamp of WebhookLastTriggered.t ]) list ]) 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