POST /apps/{appId}/webhooks
Creates a new webhook on an Amplify app.
Servers
- https://amplify.{region}.amazonaws.com
- https://amplify.{region}.amazonaws.com.cn
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
appId |
String | Yes |
The unique ID for an Amplify app. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
X-Amz-Content-Sha256 |
String | No | |
X-Amz-Credential |
String | No | |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Amz-Date |
String | No | |
X-Amz-Algorithm |
String | No | |
X-Amz-SignedHeaders |
String | No | |
X-Amz-Security-Token |
String | No | |
X-Amz-Signature |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
The description for a webhook. |
branchName |
String | Yes |
The name for a branch that is part of an Amplify app. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.