Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

UpdateWebhook - Amplify

UpdateWebhook

Updates a webhook.

Request Syntax

POST /webhooks/webhookId HTTP/1.1 Content-type: application/json { "branchName": "string", "description": "string" }

URI Request Parameters

The request uses the following URI parameters.

webhookId

The unique ID for a webhook.

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Required: Yes

Request Body

The request accepts the following data in JSON format.

branchName

The name for a branch that is part of an Amplify app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Required: No

description

The description for a webhook.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

Required: No

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 a webhook that connects repository events to an Amplify app.

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

DependentServiceFailureException

An operation failed because a dependent service threw an exception.

HTTP Status Code: 503

InternalFailureException

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

HTTP Status Code: 500

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:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.