Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
Inputs
フィールド
種類
説明
region [required]
enum
default: us-east-1
nextToken
string
The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
maxResults
number
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Outputs
Expand All
フィールド
種類
説明
amzRequestId [required]
string
webhooks
[object]
The JSON detail returned for each webhook in the list output for the ListWebhooks call.
definition [required]
object
The detail returned for each webhook, such as the webhook authentication type and filter rules.
name [required]
string
The name of the webhook.
targetPipeline [required]
string
The name of the pipeline you want to connect to the webhook.
targetAction [required]
string
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
filters [required]
[object]
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
jsonPath [required]
string
A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
matchEquals
string
The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.
authentication [required]
string
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website. IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration. UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
authenticationConfiguration [required]
object
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
AllowedIPRange
string
The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
SecretToken
string
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
url [required]
string
A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
errorMessage
string
The text of the error message about the webhook.
errorCode
string
The number code of the error.
lastTriggered
date-time
The date and time a webhook was last successfully triggered, in timestamp format.
arn
string
The Amazon Resource Name (ARN) of the webhook.
tags
[object]
Specifies the tags applied to the webhook.
key [required]
string
The tag's key.
value [required]
string
The tag's value.
NextToken
string
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.
