# ListWebhooks
<a name="API_ListWebhooks"></a>

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.

**Note**  
If a secret token was provided, it will be redacted in the response.

## Request Syntax
<a name="API_ListWebhooks_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListWebhooks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListWebhooks_RequestSyntax) **   <a name="CodePipeline-ListWebhooks-request-MaxResults"></a>
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListWebhooks_RequestSyntax) **   <a name="CodePipeline-ListWebhooks-request-NextToken"></a>
The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListWebhooks_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "webhooks": [ 
      { 
         "arn": "string",
         "definition": { 
            "authentication": "string",
            "authenticationConfiguration": { 
               "AllowedIPRange": "string",
               "SecretToken": "string"
            },
            "filters": [ 
               { 
                  "jsonPath": "string",
                  "matchEquals": "string"
               }
            ],
            "name": "string",
            "targetAction": "string",
            "targetPipeline": "string"
         },
         "errorCode": "string",
         "errorMessage": "string",
         "lastTriggered": number,
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "url": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListWebhooks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListWebhooks_ResponseSyntax) **   <a name="CodePipeline-ListWebhooks-response-NextToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [webhooks](#API_ListWebhooks_ResponseSyntax) **   <a name="CodePipeline-ListWebhooks-response-webhooks"></a>
The JSON detail returned for each webhook in the list output for the ListWebhooks call.  
Type: Array of [ListWebhookItem](API_ListWebhookItem.md) objects

## Errors
<a name="API_ListWebhooks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListWebhooks_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/codepipeline-2015-07-09/ListWebhooks) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codepipeline-2015-07-09/ListWebhooks)