Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateWebhook

Creates a new webhook on an Amplify app.

Request Syntax


POST /apps/appId/webhooks HTTP/1.1
Content-type: application/json

{
   "branchName": "string",
   "description": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for an Amplify app.

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

Pattern: d[a-z0-9]+

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: Yes

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

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