ListWebhooks
Gets a listing of all the webhooks in this AWS 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
{
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
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
-
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
{
"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
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
-
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
-
The JSON detail returned for each webhook in the list output for the ListWebhooks call.
Type: Array of ListWebhookItem objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
