GetWebhook - AWS Amplify

GetWebhook

Returns the webhook information that corresponds to a specified webhook ID.

Request Syntax

GET /webhooks/webhookId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

webhookId

The unique ID for a webhook.

Length Constraints: Maximum length of 255.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "webhook": { "branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", "webhookUrl": "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.

webhook

Describes the structure of a webhook.

Type: Webhook object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A request contains unexpected data.

HTTP Status Code: 400

InternalFailureException

The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500

LimitExceededException

A resource could not be created because service quotas were exceeded.

HTTP Status Code: 429

NotFoundException

An entity was not found during an operation.

HTTP Status Code: 404

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: